JavaDoc

JavaDoc支持HTML代码与标记@。上例中，实现了换行。如果您熟悉HTML语法，便很容易理解。关于@，如果我们希望javadoc工具生成更详细的文档信息，例如为方法参数、方法返回值等生成详细的说明信息，则可以利用javadoc标记，有如下标记：

　　@author 作者名

　　@version 版本标识

　　@parameter 参数及其意义

　　@since 最早使用该方法/类/接口的JDK版本

　　@return 返回值

　　@throws 异常类及抛出条件

　　@deprecated 引起不推荐使用的警告

　　@see reference

　　@override 重写

　　JavaDoc工具相关用法

　　javadoc命令可对源文件、包来生成API文档，常用选项有如下几个：

　　javadoc [选项] [软件包名称] [源文件] [@file]

　　-overview 读取 HTML 文件的概述文档

　　-public 仅显示公共类和成员

　　-protected 显示受保护/公共类和成员(默认)

　　-package 显示软件包/受保护/公共类和成员

　　-private 显示所有类和成员

　　-help 显示命令行选项并退出

　　-doclet 通过替代 doclet 生成输出

　　-docletpath 指定查找 doclet 类文件的位置

　　-sourcepath 指定查找源文件的位置

　　-classpath 指定查找用户类文件的位置

　　-exclude 指定要排除的软件包的列表

　　-subpackages 指定要递归装入的子软件包

　　-breakiterator 使用 BreakIterator 计算第 1 句

　　-bootclasspath 覆盖引导类加载器所装入的类文件的位置

　　-source 提供与指定版本的源兼容性

　　-extdirs 覆盖安装的扩展目录的位置

　　-verbose 输出有关 Javadoc 正在执行的操作的消息

　　-locale 要使用的语言环境，例如 en_US 或 en_US_WIN

　　-encoding 源文件编码名称

　　-quiet 不显示状态消息

　　-J 直接将 传递给运行时系统