Java 支持三种注释方式。
第一种: //
第二种:/* */
第三种:/** */
标签 | 描述 |
@author | 标识一个类的作者 |
@deprecated | 指明一个过期的类或成员 |
{@docRoot} | 指明当前文档根目录的路径 |
@exception | 标志一个类抛出的异常 |
{@inheritDoc} | 从直接父类继承的注释 |
{@link} | 插入一个到另一个主题的链接 |
{@linkplain} | 插入一个到另一个主题的链接,但是该链接显示纯文本字体 |
@param | 说明一个方法的参数 |
@return | 说明返回值类型 |
@see | 指定一个到另一个主题的链接 |
@serial | 说明一个序列化属性 |
@serialData | 说明通过writeObject( ) 和 writeExternal( )方法写的数据 |
@serialField | 说明一个ObjectStreamField组件 |
@since | 标记当引入一个特定的变化时 |
@throws | 和 @exception标签一样. |
{@value} | 显示常量的值,该常量必须是static属性。 |
@version | 指定类的版本 |
在Javadoc文档注释中,每一行的 @ 前面建议都加上 *
(也可不加) 。
/** 这个类定义了xx功能
* @author THRFUR
* @version 1.0.2
*/
在自由格式文本中,可以使用HTML标识符。例如,用于强调的<em>...</em>
、用于着重强调的<strong>...</strong>
以及包含图像的<img ..>等。不过,一定不要使用<h1>
或<hr>
,因为它们会与文档的格式产生冲突。若要键入等宽代码,需使用{@code...}
而不是<code>...</code>
,这样一来,就不用操心对代码中的<
字符转义了。
类注释必须放在import
语句之后,类定义之前。