javadoc命令

参考资料

[1]. 疯狂Java讲义（第三版） 李刚
[2]. 官方文档下载，
http://www.oracle.com/technetwork/java/javase/downloads/index.html
[3]. JavaDoc生成API详解，
http://blog.csdn.net/fanxiaobin577328725/article/details/52658781

官方文档使用

下载

进入[2]网站以后，搜索“Additional Resources”，就可以看到下载列表

解压

下载完成后，解压到任意文件夹，可以得到一个“docs”文件夹。

打开

进入“doc”文件夹后，点击index.html即可打开。

自制文档

javadoc命令

javadoc命令的基本用法如下

javadoc 选项 Java源文件 | 包

案例1

准备两个测试类
JavadocTest.java

package lee;
/**
 * Description:
 * <br>网站: <a href="http://www.crazyit.org">疯狂Java联盟</a>
 * <br>Copyright (C), 2001-2016, Yeeku.H.Lee
 * <br>This program is protected by copyright laws.
 * <br>Program Name:
 * <br>Date:
 * @author Yeeku.H.Lee kongyeeku@163.com
 * @version 1.0
 */
public class JavadocTest
{
    /**
     * 简单测试成员变量
     */
    protected String name;
    /**
     * 主方法，程序的入口
     */
    public static void main(String[] args)
    {
        System.out.println("Hello World!");
    }
}

Test.java

package yeeku;

/**
 * Description:
 * <br>网站: <a href="http://www.crazyit.org">疯狂Java联盟</a>
 * <br>Copyright (C), 2001-2016, Yeeku.H.Lee
 * <br>This program is protected by copyright laws.
 * <br>Program Name:
 * <br>Date:
 * @author Yeeku.H.Lee kongyeeku@163.com
 * @version 1.0
 */
public class Test
{
    /**
     * 简单测试成员变量
     */
    public int age;
    /**
     * Test类的测试构造器
     */
    public Test()
    {
    }
}

-d指定输出文件的目标目录， -windowtitle文档的浏览器窗口标题
-doctitle 包含概览页面的标题， -header 包含每个页面的页眉文本
指定要执行的类是 *.Test.java
然后执行下面的命令，即可看到

javadoc -d apidoc -windowtitle 测试 -doctitle 学习 javadoc 工具
的测试 API文档 -header 我的类 *Test.java

如果不想使用太多选项，只用默认的话，可以使用下面的命令

javadoc -d apidoc *Test.java