Java支持三种形式的注释。前两种是// 和/* */。第三种方式被称为文档注释。它以“/**”开始,以“*”标志结束。文档注释提供将程序信息嵌入程序的功能。开发者可以使用javadoc工具将信息取出,然后转换为HTML文件。文档注释提供了编写程序文档的便利方式。javadoc工具生成的文档几乎人人都看过,因为Sun的Java API文档库就是这么生成的。
javadoc标记
javadoc实用程序识别下列标记:
Tag标记 |
意义 |
@author |
确定类的作者 |
@deprecated |
指示反对使用这个类或成员 |
{@docRoot} |
指定当前文档的根目录路径 (Java 2的1.3版新增) |
@exception |
确定一个方法引发的异常 |
{@link} |
插入对另一个主题的内部链接 |
@param |
为方法的参数提供文档 |
@return |
为方法的返回值提供文档 |
@see |
指定对另一个主题的链接 |
@serial |
为默认的可序列化字段提供文档 |
@serialData |
为writeObject( )或者writeExternal( )方法编写的数据提供文档 |
@serialField |
为ObjectStreamField组件提供文档 |
@since |
当引入一个特定改变时,声明发布版本 |
@throws |
与& |