Java javadoc工具

我们可以借助javadoc工具在Java中创建API文档 。如果需要生成API文档，我们在编写Java文件时，必须使用文档注释/**...* /来注释类，方法，构造方法，属性等信息。

1 使用javadoc生成文档

1.1 编写包含文档注释的类

package com.yiidian;

/**
 * 一点教程网： http://www.yiidian.com
 */
/**
 * 此类是用户定义的类，其中包含一个方法多维数据集。
 */
public class Demo{

    /** 多维数据集方法: 打印给定数字的多维数据集 */
    public static void  cube(int n){
        System.out.println(n*n*n);
    }
}

1.2 使用javadoc生成文档

要创建API文档，您需要使用javadoc工具，后跟Java文件名。无需提前编译Java文件。

在cmd命令提示符下，您需要输入：

javadoc Demo.java

输入以上命令后，API文档就生成啦。现在，你可以看到很多html文件。打开index.html可以查看类的信息。