Javadoc

javadoc: https://en.wikipedia.org/wiki/Javadoc

工具:Doxygen and Appledoc.

Some of the available Javadoc tags[6] are listed in the table below:

Tag & ParameterUsageApplies toSince
@author John Smith 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. Class, Interface, Enum, Field, Method  
{@inheritDoc} Copies the description from the overridden method. Overriding Method 1.4.0
{@link reference} Link to other symbol. Class, Interface, Enum, Field, Method  
{@value #STATIC_FIELD} Return the value of a static field. Static Field 1.4.0
{@code literal} Formats literal text in the code font. It is equivalent to <code>{@literal}</code>. Class, Interface, Enum, Field, Method 1.5.0
{@literal literal} Denotes literal text. The enclosed text is interpreted as not containing HTML markup or nested javadoc tags. Class, Interface, Enum, Field, Method 1.5.0

原文地址:https://www.cnblogs.com/Bob-wei/p/5053545.html