Java之生成API帮助文档

DOS命令生成API帮助文档

新建一个空白记事本，输入下列代码

public class Test{
    /**
     * 求输入两个参数范围以内整数的和
     * @param n 接收的第一个参数，范围起点
     * @param m 接收的第二个参数，范围终点
     * @return 两个参数范围以内整数的和
     */
    public int add(int n, int m) {
        int sum = 0;
        for (int i = n; i <= m; i++) {
            sum = sum + i;
        }
        return sum;
    }
} 

将文件命名为 Test.java，打开 cmd 窗口，输入javadoc -author -version Test.java命令。

打开 Test.java 文件存储的位置，会发现多出了一个 Test.html 文档。

注意：以上没有考虑编码格式的问题，注释中有汉字可能会乱码。使用javadoc -encoding UTF-8 -charset UTF-8 Test.java会解决编码问题。

MyEclipse生成API帮助文档

在 MyEclipse 中新建一个 Test 类，代码如下：

package test;

public class Test {
    public static void main(String[] args) {
        
        System.out.println("test");
    }
}

1. 在项目名处单击鼠标右键，然后选择Export…
2. 在弹出窗口中选择 Java 文件夹，点击 Java 文件夹下面的
   Javadoc，然后点击“Next”。
3. 选择你要生成 Javadoc 的项目，并更改你想保存的 API 帮助文档地址（默认为工程目录下，建议不要修改）。点击“Finish”。
4. 点击“Finish”之后会问是否更新 Javadoc 文件的位置，只需要点击“Yes To All”即可
5. 这时可以看到控制台输出生成 Javadoc 的信息
6. 打开保存的文件夹，找到 Test.html 文件并打开

以上就是使用 MyEclipse 简单建立一个 API 帮助文档的过程。