黑马程序员技术交流社区

标题: JavaDoc文档 小结 [打印本页]

---

作者: 帅哥哥    时间: 2014-5-8 10:48
标题: JavaDoc文档 小结




一. 概述
        Java 类通过 JavaDoc 文档来对外公布自身的用法，JavaDoc 文档是基于 HTML 格式的帮助文档。JavaDoc 文档是供 Java 开发人员阅读的，他们通过 JavaDoc 文档来了解其他开发人员的类的用法。Java 开发人员应该养成经常查阅 JavaDoc 文档的良好习惯。        JDK中提供了一个 javadoc.exe 程序，它能够识别 Java 源文件中符合特定规范的注释语句，根据这些注释语句自动生成 JavaDoc 文档。在 Java 源文件中，只有满足特定规范的注释才会生成 JavaDoc 文档，这些规范包括：

• 注释以 /** 开始，并以 */ 结束，里面可以包含普通文本、HTML标记和 JavaDoc 标记。
• JavaDoc 命令只处理 Java源文件中在类声明、接口声明、成员方法声明、成员变量声明及构造方法声明之前的注释，忽略位于其他地方的注释。
  

二. JavaDoc 标记
        在构成 JavaDoc 文档的注释语句中，可以使用 JavaDoc 标记来描述作者、版本、方法参数和方法返回值等信息。常见的 JavaDoc 标记的作用如下：

• @version    指定版本信息
• @since       指定最早出现在哪个版本
• @author    指定作者
• @see          生成参考其它 JavaDoc 文档的链接
• @link         生成参考其它 JavaDoc 文档的链接，他和 @see 的区别在于，@link 标记能够嵌入到注释语句中，为注释语句中的特定词汇生成链接
• @deprecated    用来表明被注释的类、变量或方法已经不提倡使用，在将来的版本中有可能被废弃
• @param     描述方法的参数
• @return     描述方法的返回值
• @throws    描述方法抛出的异常，指明抛出异常的条件
  

三. javadoc 命令的用法
javadoc 命令包含许多命令选项，常用的命令选项有：

• -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<directory>                    指定 JavaDoc 文档的输出目录，参数的默认值为当前目录
  

javadoc 命令的使用格式如下

• javadoc [options] [packagenames] [sourcefiles]
  

javadoc 命令既可以处理包，也可以处理 Java 源文件。

确切的说，顶层类（相对于内部类）的访问级别只能是 public 和默认级别，而类的成员（包括构造方法、成员变量和成员方法）的访问级别可以是 public、protected、默认和 private 级别。

---

作者: 苏周周    时间: 2014-5-22 21:19
支持一次

---

欢迎光临 黑马程序员技术交流社区 (http://bbs.itheima.com/)

黑马程序员IT技术论坛 X3.2