javadoc注释规范

《javadoc注释规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、javadoc做注释 一.Java文档 //注释一行 /*......*/注释若干行 /**......*/注释若干行，并写入javadoc文档 通常这种注释的多行写法如下： /** *......... *......... */ javadoc-d文档存放目录-author-version源文件名.java 这条命令编译一个名为“源文件名.java”的java源文件，并将生成的文档存放在“文档存放目录”指定的目录下，生成的文档中index.html就是文档的首页。-author和-versio

2、n两个选项可以省略。 二.文档注释的格式 1.文档和文档注释的格式化 生成的文档是HTML格式，而这些HTML格式的标识符并不是javadoc加的，而是我们在写注释的时候写上去的。 比如，需要换行时，不是敲入一个回车符，而是写入
，如果要分段，就应该在段前写入

。 文档注释的正文并不是直接复制到输出文件(文档的HTML文件)，而是读取每一行后，删掉前导的*号及*号以前的空格，再输入到文档的。如 /** *Thisisfirstline.
 *****Thisissecondline

3、.
 Thisisthirdline. */ 2.文档注释的三部分 先举例如下 /** *show方法的简述. *

show方法的详细说明第一行
 *show方法的详细说明第二行 *@parambtrue表示显示，false表示隐藏 *@return没有返回值 */ publicvoidshow(booleanb){ frame.show(b); } 第一部分是简述。文档中，对于属性和方法都是先有一个列表，然后才在后面一个一个的详细的说明 简述部分写在一段文档注释的最前面，第一个点

4、号(.)之前(包括点号)。换句话说，就是用第一个点号分隔文档注释，之前是简述，之后是第二部分和第三部分。 第二部分是详细说明部分。该部分对属性或者方法进行详细的说明，在格式上没有什么特殊的要求，可以包含若干个点号。 *show方法的简述. *

show方法的详细说明第一行
 *show方法的详细说明第二行 简述也在其中。这一点要记住了 第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。 *@parambtrue表示显示，false表示隐藏 *@return没有返回值 三

5、.使用javadoc标记 javadoc标记由“@”及其后所跟的标记类型和专用注释引用组成 javadoc标记有如下一些： @author标明开发该类模块的作者 @version标明该类模块的版本 @see参考转向，也就是相关主题 @param对方法中某参数的说明 @return对方法返回值的说明 @exception对方法可能抛出的异常进行说明 @author作者名 @version版本号 其中，@author可以多次使用，以指明多个作者，生成的文档中每个作者之间使用逗号(,)隔开。@versi

6、on也可以使用多次，只有第一次有效 使用@param、@return和@exception说明方法 这三个标记都是只用于方法的。@param描述方法的参数，@return描述方法的返回值，@exception描述方法可能抛出的异常。它们的句法如下： @param参数名参数说明 @return返回值说明 @exception异常类名说明 四.javadoc命令 用法： 　　javadoc[options][packagenames][sourcefiles] 选项： -public仅显示public

7、类和成员 -protected显示protected/public类和成员(缺省) -package显示package/protected/public类和成员 -private显示所有类和成员 -d输出文件的目标目录 -version包含@version段 -author包含@author段 -splitindex将索引分为每个字母对应一个文件 -windowtitle文档的浏览器窗口标题 javadoc编译文档时可以给定包列表，也可以给出源程序文件列表。例如在

8、CLASSPATH下有两个包若干类如下： 　　fancy.Editor 　　fancy.Test 　　fancy.editor.ECommand 　　fancy.editor.EDocument 　　fancy.editor.EView 可以直接编译类： javadocfancyTest.javafancyEditor.javafancyeditorECommand.javafancyeditorEDocument.javafancyeditorEView.java