前言
Java中有三种注释方式。前两种分别是 // 和 /* /,主要用于代码的注释,以此来方便代码的可读性。第三种被称作说明注释或文档注释,它以 /* 开始,以 /结束,文档注释允许你在程序中嵌入关于程序的信息,有了这个注释就可以使用 javadoc 工具软件来生成信息,并输出到HTML文件中。
2.文档注释的格式
/*
*…
/
之后,你可以包含一个或多个各种各样的 @ 标签。每一个 @ 标签必须在一个新行的开始或者在一行的开始紧跟星号(),其中常用的标签如下(详细标签请参考http://www.runoob.com/java/java-documentation.html):
标签 描述 示例
@author 标识一个类的作者 @author description
@version 指定类的版本 @version info
@param 说明一个方法的参数 @param parameter-name explanation
@return 说明返回值类型 @return explanation