Java基础12：使用Javadoc命令生成文档

一、Java文档注释

 Java 支持三种注释方式。前两种分别是 // 和 /* */，第三种被称作说明注释，它以 /** 开始，以 */结束。说明注释允许你在程序中嵌入关于程序的信息。你可以使用 Javadoc 工具软件来生成信息，并输出到HTML文件中。

二、文档注释的格式

/**

* .........

* .........

*/

在开始的 /** 之后，第一行或几行是关于类、变量和方法的主要描述。

之后，你可以包含一个或多个各种各样的 @ 标签。每一个 @ 标签必须在一个新行的开始或者在一行的开始紧跟星号(*)，其中常用的标签如下

标签	描述	示例
@author	标识一个类的作者	@author description
@version	指定类的版本	@version info
@param	说明一个方法的参数