java学习笔记——文档注释标记总结

文档注释的表示

每个/**...*/文档注释包含不定数个标记,以及其后面的的自由格式文本.每个标记以@开始
在自由格式文本中可以使用常用的html字符

@param variable description

参数注释(一个方法所有的参数注释必须放在一起)

@return description

返回值的注释

@throws class description

可能抛出的异常注释

@since text

text可以是引入这个特性的版本的任何描述

@author name

标注作者(可以多个)

@version text

对当前版本的任何描述

@see @link

提供一个超链接

@see com.horstmann.corejava.Emplyee#raiseSalary(double)
@see <a href=www.asdfa.html">The Core Java home page</a>
@see "Core Java 2 volume 2"
{@link pacage.class#feature label}

包注释

1. 提供一个名为package-info.java的文件,包含一个问当主食和package语句
2. 提哦那个一个名为package.html文件,会抽取…之间的所有文本