使用WINDOWS命令生成API文档

使用WINDOWS命令生成API文档

分为两步：
一：编写Java文件，用文档注释对成员变量和方法进行文档注释。像如下代码：

package luo;
/**
* 学习如何生成JAVA API文档
* @author luo
* @version 1.0
*/
public class JavaTagTest{
    
    
    /**
    * 一个得到打招呼字符串的方法
    * @param name 该参数指定向谁打招呼
    * @return 返回打招呼的字符串 
    */
	public String hello(String name){
    
    
	  return name + ",你好！";
	}
}

二：在WINDOWS控制台中，到保存java源文件的路径下执行如下语句：

javadoc -d apidoc -encoding GBK -charset GBK -windowtitle 测试 -doctitle 学习Javadoc的测试API文档 -header 我的类-version -author  JavaTagTest.java       

命令解析：
-d 《directory》:指定一个路径，用于将生成的API文档将存放在这个路径下。
-windowtitle《text》:指定一个字符串，用于设置API文档的浏览器窗口标题。
-doctitle《html-code》:指定一个HTML格式的文本，用于概述页面的标题。
-header《html-code》:指定一个HTML格式的文本，用于做每个页面的页眉。
-version:提取文档@version标记信息。
-author:提取文档@author标记信息。

就会在Java源路径下生成一个apidoc文件夹，在里面打开index.html，就可以得到如下图的API文档。