javadoc注释规范.doc

javadoc 注释规范 javadoc 是 Java 语言中的一种文档注释工具，用于生成 HTML 格式的文档。根据给定的文件信息，我们可以总结出以下知识点： 一、javadoc 注释的基本格式 javadoc 注释以「/」开头，以「*/」结尾。多行注释可以使用「*」符号换行。 二、文档注释的格式 文档注释的格式化生成的文档是 HTML 格式。文档注释的正文并不是直接复制到输出文件，而是读取每一行后，删掉前导的「*」号及「*」号以前的空格，再输入到文档的。 三、文档注释的三部分 文档注释可以分为三部分： 1. 简述部分：对方法或属性的简要说明。 2. 详细说明部分：对方法或属性的详细说明。 3. 特殊说明部分：包括版本说明、参数说明、返回值说明等。 四、javadoc 标记 javadoc 标记由「@」及其后所跟的标记类型和专用注释引用组成。常见的 javadoc 标记有： * @author：标明开发该类模块的作者 * @version：标明该类模块的版本 * @see：参考转向，也就是相关主题 * @param：对方法中某参数的说明 * @return：对方法返回值的说明 * @exception：对方法可能抛出的异常进行说明 五、javadoc 命令用法 javadoc 命令的基本格式为： javadoc [options] [packagenames] [sourcefiles] 其中，options 可以是以下几种： * -public：仅显示 public 类和成员 * -protected：显示 protected/public 类和成员 (缺省) * -package：显示 package/protected/public 类和成员 * -private：显示所有类和成员 * -d <directory>：输出文件的目标目录 * -version：包含 @version 段 * -author：包含 @author 段 * -splitindex：将索引分为每个字母对应一个文件 * -windowtitle <text>：文档的浏览器窗口标题 六、javadoc 的应用 javadoc 可以用于生成 Java 项目的文档，帮助开发者快速了解项目的结构和功能。同时，javadoc 也可以用于生成 Java 项目的API 文档，方便其他开发者使用项目的接口。