For class headers, method headers and member variables JavaDoc is used in order to generate API documentation. Some HTML-tags that can be used in order to make the comment blocks more readable:
-<p> | New paragraph.
-<br> | Break, a carriage return. For separation of two paragraphs, usage of
is preferred.
-<ul><li></li></ul> | Unordered list of items. Each item should start with a
<code></code> | Code samples. Use this when refering to class names, method names, parameter names, etc.
+| Tag | +Short description | +
|---|---|
<p> |
+New paragraph. | +
<br> |
+Break, a carriage return. For separation of two paragraphs, usage of is preferred. |
+
<ul><li></li></ul> |
+Unordered list of items. Each item should start with a |
+
<code></code> |
+Code samples. Use this when refering to class names, method names, parameter names, etc. | +
{note}There is no need to embed the parameter name in the @param tag in tags; this is done by JavaDoc automatically. The same holds for the exception name in the @exception or @throws tag. In the clarifying text however, use the tags when refering to parameter names etc. The example below shows the tag being used for the array parameter in the text, but not in its definition.{note}
Example:
/**