Java千百问_08JDK详解（017）_Javadoc是什么

点击进入_更多_Java千百问

1、Javadoc是什么

javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释，形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以形成开发文档了。

了解注释看这里：注释是什么

2、如何使用Javadoc

java为javadoc技术独立出了一个工具，它位于JAVA_HOME/bin/路径中，在终端中执行如下命令：

javadoc 文件名.java

javadoc工具就会根据指定的文件生成对应的文档，默认生成在同目录，我们看下面一个实例。

首先我们写一个java类，命名为Test.java，并为其添加注释：

/** * * 测试 * * @author sunjie at 2016年7月7日 * */
public class Test {

    /** * * 主方法 * * @author sunjie at 2016年7月7日 * * @param args * @throws UnsupportedEncodingException */
    public static void main(String[] args) throws UnsupportedEncodingException {

    }

    /** * * 文档方法 * * @author sunjie at 2016年7月7日 * * @param testStr * 文档参数 * @return 我是返回值 */
    public Boolean testJavadoc(String testStr) {
        return Boolean.FALSE;
    }

}

我们通过终端访问改文件的路径，执行一下命令：

javadoc Test.java

我们会看到结果：

正在加载源文件Test.java...
正在构造 Javadoc 信息...
标准 Doclet 版本 1.7.0_79
正在构建所有程序包和类的树...
正在生成/com/test/Test.html...
正在生成/com/test/package-frame.html...
正在生成/com/test/package-summary.html...
正在生成/com/test/package-tree.html...
正在生成/constant-values.html...
正在构建所有程序包和类的索引...
正在生成/overview-tree.html...
正在生成/index-all.html...
正在生成/deprecated-list.html...
正在构建所有类的索引...
正在生成/allclasses-frame.html...
正在生成/allclasses-noframe.html...
正在生成/index.html...
正在生成/help-doc.html...

这时，我们去Test.java路径，会发现生成了若干html文件，我看找到index.html并打开，开发文档成功生成，如下：

3、javadoc注释标签有哪些

在上面例子中我们可以看到，每一段注释都用了@author，这些叫做注释标签，根javadoc相关的主要有：

1. @author
   对类的说明，标明开发该类模块的作者

2. @version
   对类的说明，标明该类模块的版本

3. @see
   对类、属性、方法的说明，描述相关主题

4. @param
   对方法的说明，对方法中某参数的说明

5. @return
   对方法的说明，对方法返回值的说明

6. @throws
   对方法的说明，对方法可能抛出的异常进行说明