JavaDoc 文档是基于HTML格式的帮助文档
java源文件中 满足特定规范的注释能够构成javadoc文档
1.注释以“/**”开始 并以"*/"结束
2.javadoc命令只处理java源文件中在类声明、接口声明、成员方法声明、成员变量声明及构造函数声明之前的注释,其他地方的注释会被忽略。
JavaDoc标记
@version 指定版本信息
@since 指定最早出现在哪个版本
@author 指定作者
@see 生成参考其他javadoc文档的连接
@link 生成参考其他javadoc文档的链接
@deprecated 用来表明被注释的类、变量或者方法已经不提倡使用
@param 描述方法的参数
@return 描述方法的返回值
@throws 描述方法抛出的异常,指明抛出异常的条件
JavaDoc 用法
javadoc [options] [packagenames] [sourcefiles]
-public 仅为public访问级别的类及类成员生成javadoc文档
-protected 仅为public和protected 访问级别的类及类成员生成javadoc文档
-package 仅为public、protected和默认访问级别的类及类成员生成javadoc文档
-private 仅为public、protected、默认和private访问级别的类及类成员生成javadoc文档
-version 解析@version标记
-author 解析@author标记
-splitindex 将索引分为每个字母对应一个索引文件
-sourcepath <pathlist> 指定java源文件路径
-classpath <pathlist> 指定classpath
-d <pathlist> 指定JavaDoc文档的输出目录