Java说明注释以 /** 开始,以 */结束。
说明注释允许你在程序中嵌入关于程序的信息。你可以使用 javadoc 工具软件来生成信息,并输出到HTML文件中,使你更加方便的记录你的程序信息。
文章摘自菜鸟教程
/** 之后,先说明注释的是什么内容。
之后,你可以包含一个或多个各种各样的 @ 标签。@ 标签必须在一个新行的开始或者在一行的开始紧跟星号*.
多个相同类型的标签应该放成一组,将它们一个接一个的放在一起。
如以下例子:
/** 内容声明:说明注释的内容
* @author Alpha
* @version 1.0
*/
javadoc 工具将你 Java 程序的源代码作为输入,输出一些包含你程序注释的HTML文件。
每一个类的信息将在独自的HTML文件里。javadoc 也可以输出继承的树形结构和索引。