Due to a ransomware attack, the wiki was reverted to a July 2022 version. . We apologize for the lack of a more recent valid backup.
...
- All public/protected/package entities must have javadoc comments
- Descriptions of interfaces/classes/enums should start with a noun, e.g. "Representation of..." and avoid starting with "This class...."
- Descriptions of constructors should start with a passive verb, e.g. "Creates..." and avoid starting with "This constructor..." or "Constructor", or "Default constructor"; they should be sentences and therefore be capitalized and punctuated properly.
- Descriptions of methods should start with a passive verb, e.g. "Returns...", "Adds..." and avoid starting with "This method..."; as with constructor descriptions, they should be sentences and therefore be capitalized and punctuated properly.
- "@param name description" should be specified on the same line and wrap as needed from there; there should not be a line break between name and description
- Unit tests classes should also have class javadoc comment; methods within do not need to have javadoc comments, although it is not discouraged.
- Acronyms in comments should be properly capitalized, e.g. YANG, NETCONF, SNMP.
Descriptions should avoid gratuitous capitalization and should avoid referencing class-names unless part of a
@linkpragma.
...