Open whs opened 9 years ago
Here are some points we should apply from the Google's Java Style Guide
/**
* Multiple lines of Javadoc text are written here,
* wrapped normally...
*/
public int method(String p1) { ... }
<p>
before the first word. There must be no space after it./**
* First paragraph goes here
*
* <p>Second paragraph goes here
*
* @param p1 Description of p1 goes here
*/
public int method(String p1) { ... }
@author
, @param
, @return
, @throws, @deprecated
. If you use it, it must be followed by a description. If the description does not fit on a single line, the next line should be indented by 4 spaces.public
class and public
or protected
members of that class must be documented.
Here are some points we should apply from Oracle's How to Write Doc Comment:
<code>...</code>
{@link}
only for the first occurence of that term.{@link}
to well known packages such as java.lang
@author
by time. The creater of the class appears on top.@param
is required for all parameters@return
is always specified for methods not returning void
even if it is the same as the method description.@throws
may list unchecked exceptions. It may not be the complete list of exceptions, however.
All classes and methods should be documented with Javadoc.
A Javadocs guideline/standard should be decided before starting this task.