文档注释,它以 /** 开始,以 */ 结束。
你可以使用 javadoc 工具软件来生成信息,并输出到 HTML 文件中。
文档注释,使你更加方便的记录你的程序信息。
javadoc标签
在开始的 /** 之后,第一行或几行是关于类、变量和方法的主要描述。
之后,你可以包含一个或多个各种各样的 @ 标签。每一个 @ 标签必须在一个新行的开始或者在一行的开始紧跟星号 *。
多个相同类型的标签应该放成一组
/*** 这个类绘制一个条形图
* @author runoob
* @version 1.2
*/
javadoc 工具将你 Java 程序的源代码作为输入,输出一些包含你程序注释的HTML文件。
每一个类的信息将在独自的HTML文件里。javadoc 也可以输出继承的树形结构和索引。