Encara que sempre s'acaba copiant les capceleres de la documentació no està de més tenir la llista de tags i recordar l'ordre de aparició:
Tag & Parameter
|
Usage
|
Applies to
|
@author name
|
Describes an author.
|
Class, Interface, Enum
|
@version version
|
Provides software version entry. Max one per Class or Interface.
|
Class, Interface, Enum
|
@since since-text
|
Describes when this functionality has first existed.
|
Class, Interface, Enum, Field, Method
|
@see reference
|
Provides a link to other element of documentation.
|
Class, Interface, Enum, Field, Method
|
@param name description
|
Describes a method parameter.
|
Method
|
@return description
|
Describes the return value.
|
Method
|
@exception classname description
@throws classname description |
Describes an exception that may be thrown from this method.
|
Method
|
@deprecated description
|
Describes an outdated method.
|
Method
|
{@inheritDoc}
|
Copies the description from the overridden method.
|
Overriding Method
|
{@link reference}
|
Link to other symbol.
|
Class, Interface, Enum, Field, Method
|
{@value}
|
Return the value of a static field.
|
Static Field
|
però si vols la informació original pots escardar a:
http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html
http://en.wikipedia.org/wiki/Javadoc
No hay comentarios:
Publicar un comentario