JAVA /
COMMENTS AND JAVADOCS

Comments are not compiled information.

Types:

• single-line comment (marked with / and / before the comment; can be at beginning of somewhere inside a line)

• multi-line comment (marked with / and * at beginning, * and / at the end)

• in-row comment (in a row marked with / and * at beginning, * and / at the end)

• single-line to-do reminder (a row marked with / and / and TO and DO)

• multi-line to-do reminder (first row marked with / and / and TO and DO, next rows will start with / and / and <space>-<space>)

• single-line fix-me reminder (a row marked with / and / and FIX and ME)

• multi-line fix-me reminder (first row marked with / and / and FIX and ME, next rows will start with / and / and <space>-<space>)

• JavaDocs paragraph (marked with / and ** at the beginning, * and / at the end, * between, all three at beginning of line)

JavaDocs comments are used for:

• hint/description of element (class, interface, method, field)

• automatically generated documentation of the code

For methods with right-level verbal names and parameters names and-or their task is well-known, there is no need to create Javadocs, unless some special information is needed to be documented in order to understand the method and its why-s better. Also, if the parameters need no further details, show no description for them in Javadocs.

JavaDocs formatting characters:

• can use HTML formatting (tag-pairs)

• <p> line end

• & and lt; less-than character

• & and gt; greater-than character

• & and nbsp; tabulator character

JavaDocs tags:

• @author authorNames

• @since dd-mm-yyyy

• @version versionNumbers

• @see [ClassName][#methodName(signature)]

• @deprecated

EXAMPLE FOR COMMENTS:

JUMP TO TOP