javadoc命令基础语法格式

javadoc命令基础语法格式

• 语法

javadoc 选项 java源文件/清单文件

• 示例

javadoc -d .\api *.java

上述代码中，"-d"选项是指定API文档生成的目录，即需要在当前目录的api子目录中生成所有Java文件的API文档。执行完该命令后在api目录中打开index.html就可以看到生成文档的内容。如果希望使用javadoc工具生成更详细的文档信息，可以将javadoc标记加入到文档注释中。

标记	作用
@author	指定程序作者。用于类或接口的注释
@version	指定源文件版本。用于类或接口前注释
@deprecated	不推荐使用的方法。用于方法的注释
@param	方法的参数的说明信息。用于方法的注释
@return	方法的返回值的说明信息。用于方法的注释
@see	“参见”。用于指定交叉参考的内容
@exception	抛出异常的类型。用于方法的注释
@throws	抛出的异常，与exception同义