java doc 注解_注解生成javadoc什么意思

展开全部

javadoc 标记是插入文档注释中的特殊标记，它们用62616964757a686964616fe78988e69d8331333363393031于标识代码中的特殊引用。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 选项，则必须指定标题文本。

楼主看下这个博客吧： http://blog.csdn.net/l454822901/article/details/52639132

本回答由提问者推荐

已赞过

已踩过<

你对这个回答的评价是？

评论

收起