Javadoc guidelines

Javadoc guidelines

• Use < code > style for keywords and names
• Use in-line links economically
• Omit parentheses for the general form of methods and constructors
• OK to use phrases instead of complete sentences, in the interests of brevity
• Use 3rd person (descriptive) not 2nd person (prescriptive)
• Method descriptions begin with a verb phrase
• Class/interface/field descriptions can omit the subject and simply state the object
• Use "this" instead of "the" when referring to an object created from the current class
• Add description beyond the API name
• Be clear when using the term "field"
• Avoid Latin

Source: https://www.oracle.com/technetwork/java/javase/tech/index-137868.html