首页 > itarticle > java文档注释三种类型的文档注释标签使用

java文档注释三种类型的文档注释标签使用

admin 1月 28, 2021 0

文档注释以/*开始，/结束。javadoc命令只能在注释中出现。

三种类型的文档注释


public class {
  /** 属性层次的注释 */
  public int id;
  /** 方法层次的注释 */
  public void sayHello(){}
}

标签使用

@see

1
2
3

 classname
 fully-qualified-classname
@see fully-qualified-classname#method-name

使用“see also”作为文本链接至其他文档

label

1	{@link package.class member label}

用于行内，使用label作为链接文本

version

1	@version version-information

@author

1	@author author-information

@since

指定代码最早使用的版本

@param

1	@param paramter-name description

参数说明