javajavadoc要求_javadoc注释规范
java中的注释，⼤家应该已经很熟悉了。
⽂档注释可以⽤于对类、属性、⽅法等进⾏说明。写⽂档注释时除了需要使⽤ /** .... */ 限定之外，还需要注意注释内部的⼀些细节问题。
1⽂档和⽂档注释的格式化
⽣成的⽂档是 HTML 格式，⽽这些 HTML 格式的标识符并不是 javadoc 加的，⽽是我们在写注释的时候写上去的。⽐如，需要换⾏时，不是敲⼊⼀个回车符，⽽是写⼊ ＜br＞，如果要分段，就应该在段前写⼊ ＜p＞。
因此，格式化⽂档，就是在⽂档注释中添加相应的 HTML 标识。
⽂档注释的正⽂并不是直接复制到输出⽂件 (⽂档的 HTML ⽂件)，⽽是读取每⼀⾏后，删掉前导的 * 号及 * 号以前的空格，再输⼊到⽂档的。如 /**
* This is first line. ＜br＞
***** This is second line. ＜br＞ This is third line. */
编译输出后的 HTML 源码则是 This is first line. ＜br＞ This is second line. ＜br＞ This is third line.
前导的 * 号允许连续使⽤多个，其效果和使⽤⼀个 * 号⼀样，但多个 * 号前不能有其它字符分隔，否则分隔符及后⾯的 * 号都将作为⽂档的内容。
还有⼀点需要说明，⽂档注释只说明紧接其后的类、属性或者⽅法，如:
/** commnet forclass */
public classTest { ...... }
2⽂档注释的三部分
根据在⽂档中显⽰的效果，⽂档注释分为三部分。先举例如下，以便说明。
/**
* show ⽅法的简述.
* ＜p＞show ⽅法的详细说明第⼀⾏＜br＞ * show ⽅法的详细说明第⼆⾏
* @param b true 表⽰显⽰，false 表⽰隐藏
java中split的用法
* @return 没有返回值
*/
public voidshow(boolean b) { frame.show(b); }
第⼀部分是简述，列表中属性名或者⽅法名后⾯那段说明就是简述。简述部分写在⼀段⽂档注释的最前⾯，第⼀个点号 (.) 之前 (包括点号)。换句话说，就是⽤第⼀个点号分隔⽂档注释，之前是简述，之后是第⼆部分和第三部分。如上例中的 “* show ⽅法的简述.”。
有时，即使正确地以⼀个点号作为分隔，javadoc 仍然会出错，把点号后⾯的部分也做为了第⼀部分。为了解决这个问题，我们可以使⽤⼀个 ＜p＞ 标志将第⼆分部分分开，如上例的“* ＜p＞show ⽅法的详细说明第⼀⾏ ....”。
第⼆部分是详细说明部分。该部分对属性或者⽅法进⾏详细的说明，在格式上没有什么特殊的要求，可以包含若⼲个点号。
第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。第三部分在上例中相应的代码是：
* @param b true 表⽰显⽰，false 表⽰隐藏
* @return 没有返回值
除了 @param 和 @return 之外，还有其它的⼀些特殊标记，分别⽤于对类、属性和⽅法的说明。
三. 使⽤ javadoc 标记
javadoc 标记是插⼊⽂档注释中的特殊标记，它们⽤于标识代码中的特殊引⽤。javadoc 标记由“@”及其后所跟的标记类型和专⽤注释引⽤组成。记住了，三个部分——@、标记类型、专⽤注释引⽤。虽然 @ 和 标记类型之间有时可以⽤空格符分隔，但是推荐将它们紧挨着写，以减少出错机会。
javadoc 标记有如下⼀些：
标记                            ⽤于                                                        作⽤
@author          对类的说明                                          标明开发该类模块的作者
@version          对类的说明                                          标明该类模块的版本
@see                对类、属性、⽅法的说明              参考转向，也就是相关主题
@param          对⽅法的说明                                    对⽅法中某参数的说明
@return                    对⽅法的说明                                    对⽅法返回值的说明
@exception    对⽅法的说明                                    对⽅法可能抛出的异常进⾏说明
1 @see 的使⽤
@see 的句法有三种：
@see 类名
@see #⽅法名或属性名
@see 类名#⽅法名或属性名
例:
/**
* @see    java.lang.String
* @see    #str
* @see    #str()
* @see  #main(String[])
* @see    java.lang.Object#toString()
*/
public classTestJavaDoc  {
private Stringstr;
public voidstr(){  }
public staticvoid main(String[] args){  }
}
⽣成的⽂档的相关部分如下图
2. 使⽤ @author、@version 说明类
这两个标记分别⽤于指明类的作者和版本。缺省情况下 javadoc 将其忽略，但命令⾏开关 -author 和 -version 可以修改这个功能，使其包含的信息被输出。
这两个标记的句法如下：
@author 作者名
@version 版本号
其中，@author 可以多次使⽤，以指明多个作者，⽣成的⽂档中每个作者之间使⽤逗号 (,) 隔开。@version 也可以使⽤多次，只有第⼀次有效，⽣成的⽂档中只会显⽰第⼀次使⽤ @version 指明的版本号。如下例
/**
* @author Fancy
* @author Bird
* @versionVersion 1.00
* @versionVersion 2.00
*/
public classTestJavaDoc {}
⽣成⽂档的相关部分如图
3. 使⽤ @param、@return 和 @exception 说明⽅法
这三个标记都是只⽤于⽅法的。@param 描述⽅法的参数，@return描述⽅法的返回值，@exception 描述⽅法可能抛出的异常。它们的句法如下：
@param 参数名 参数说明
@return 返回值说明
@exception 异常类名 说明
每⼀个 @param 只能描述⽅法的⼀个参数，所以，如果⽅法需要多个参数，就需要多次使⽤ @param 来描述。
⼀个⽅法中只能⽤⼀个 @return，如果⽂档说明中列了多个@return，则 javadoc 编译时会发出警告，且只有第⼀个 @return 在⽣成的⽂档中有效。
⽅法可能抛出的异常应当⽤@exception 描述。由于⼀个⽅法可能抛出多个异常，所以可以有多个 @exception。每个 @exception 后⾯应有简述的异常类名，说明中应指出抛出异常的原因。需要注意的是，异常类名应该根据源⽂件的 import 语句确定是写出类名还是类全名。⽰例如下：
public class TestJavaDoc {
/**
* @param n a switch
* @param b excrescent parameter
* @return true or false
* @return excrescent return
* @exception java.lang.Exception throw when switch is 1
* @exception NullPointerException throw when parameter n is null
*/
public boolean fun(Integer n) throws Exception {
switch (n.intValue()) {
case 0:
break;
case 1:
throw new Exception("Test Only");
default:
return false;
}
return true;
}
}
使⽤ javadoc 编译⽣成的⽂档相关部分如下图：
四. javadoc 命令
运⾏： javadoc -help 可以看到 javadoc 的⽤法，这⾥列举常⽤参数如下：
⽤法：javadoc [options][packagenames] [sourcefiles]
选项：
-public 仅显⽰ public 类和成员
-protected 显⽰protected/public 类和成员 (缺省)
-package 显⽰package/protected/public 类和成员
-
private 显⽰所有类和成员
-d ＜directory＞ 输出⽂件的⽬标⽬录
-version 包含 @version 段
-author 包含 @author 段
-splitindex 将索引分为每个字母对应⼀个⽂件
-windowtitle ＜text＞ ⽂档的浏览器窗⼝标题
javadoc 编译⽂档时可以给定包列表，也可以给出源程序⽂件列表。例如在 CLASSPATH 下有两个包若⼲类如下：
fancy.Editor  fancy.Test
fancy.editor.ECommand
fancy.editor.EDocument
fancy.editor.EView  这⾥有两个包 (fancy 和fancy.editor) 和 5 个类。那么编译时 (Windows 环境) 可以使⽤如下 javadoc 命令：
javadocfancy\Test.java fancy\Editor.java fancy\editor\ECommand.java
fancy\editor\EDocument.javafancy\editor\EView.java
这是给出 java 源⽂件作为编译参数的⽅法，注意命令中指出的是⽂件路径，应该根据实际情况改变。也可以是给出包名作为编译参数，如：
javadoc fancyfancy.editor
⽤浏览器打开⽣成⽂档的index.html ⽂件即可发现两种⽅式编译结果的不同，如下图：
⽤第⼆条命令⽣成的⽂档被框架分成了三部分：包列表、类列表和类说明。在包列表中选择了某个包之后，类列表中就会列出该包中的所有类；在类列表中选择了某个类之后，类说明部分就会显⽰出该类的详细⽂档
下⾯再来细说选项。
-
public、-protected、-package、-private 四个选项，只需要任选其⼀即可。它们指定的显⽰类成员的程度。它们显⽰的成员多少是⼀个包含的关系，如下：
-private (显⽰所有类和成员)
-package (显⽰package/protected/public 类和成员)
-protected (显⽰protected/public 类和成员)
-public (仅显⽰ public 类和成员)
-d 选项允许你定义输出⽬录。如果不⽤ -d 定义输出⽬录，⽣成的⽂档⽂件会放在当前⽬录下。-d 选项的⽤法是
-d ⽬录名
⽬录名为必填项，也就是说，如果你使⽤了-d 参数，就⼀定要为它指定⼀个⽬录。这个⽬录必须已经存在了，如果还不存在，请在运⾏javadoc 之前创建该⽬录。
-version 和 -author ⽤于控制⽣成⽂档时是否⽣成@version 和 @author 指定的内容。不加这两个参数的情况下，⽣成的⽂档中不包含版本和作者信息。
-splitindex 选项将索引分为每个字母对应⼀个⽂件。默认情况下，索引⽂件只有⼀个，且该⽂件中包含所有索引内容。当然⽣成⽂档内容不多的时候，这样做⾮常合适，但是，如果⽂档内容⾮常多的时候，这个索引⽂件将包含⾮常多的内容，显得过于庞⼤。使⽤ -splitindex 会把索引⽂件按各索引项的第⼀个字母进⾏分类，每个字母对应⼀个⽂件。这样，就减轻了⼀个索引⽂件的负担。
-windowtitle 选项为⽂档指定⼀个标题，该标题会显⽰在窗⼝的标题栏上。如果不指定该标题，⽽默认的⽂档标题为“⽣成的⽂档(⽆标题)”。该选项的⽤法是：
-windowtitle 标题  标题是⼀串没有包含空格的⽂本，因为空格符是⽤于分隔各参数的，所以不能包含空格。同 -d 类似，如果指定了 -windowtitle 选项，则必须指定标题⽂本。
本⽂参考⾃：
百度⽂库

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。