...
Code Block | ||||
---|---|---|---|---|
| ||||
/**
* Type description.
*
* @author @java.author
* @version @java.version
*/
|
Every method, field or initializer public, private or protected in top-level, inner or anonymous type should have at least minimal Javadoc comments including description and description of parameters using @param, @return and @throws Javadoc tags, where applicable. For example:
...
Comments should be separated by space from "// ", "/ , "/** "* or " */". For example, / Notice the space. /
Only package level importing is allowed (Use per-class importing is NOT allowed).
In case of the naming conflict - use fully qualified names (FQN).
Use imports instead of FQNs in Javadoc links.
...