利用javadoc制作API文档

要制作API文档，首先要保证代码中的文档注释无误，文档注释以【 /** 】开始，【 */ 】结尾，示例如下：

package jtest;
/**
 * Description:
 * <br/>网站: <a href="http://blog.csdn.net/ibooks">Monkey王！的博客</a> 
 * <br/>Copyright (C), 2012, Monkey王！
 * <br/>This is Monkey王's blog!Welcome!.
 * @author Monkey王！
 * @version 1.0
 */
public class Monkey{
/**
  *返回打招呼字符串的方法
  *@param name 该参数指定向谁打招呼
        *@return 返回打招呼的字符串
*/
public String hello(String name){
return name+"，你好！";
}
}
（PS:以上注释中@author、@version、@param、@return是常用的javadoc标记。）

javadoc命令格式如下：javadoc [选项] [Java源文件/包名]。

1.常用选项有：-d、-windowtitle、-doctitle、-header、-version、-author等。

2.示例：现有JavaMonkey.java、Monkey.java两个源文件，分别存放在jtest、test两个包里。

windows键+R-->cmd-->进入包或者源文件所在位置-->输入以下命令：

javadoc -d 要保存api文档的路径 -windowtitle api文档的浏览器标题 -doctitle api文档的概述页面的标题 -header 页面的页眉 -version -author jtest test  （每个参数和设定的值之间用空格分割开来。）

注意：

1 确保保存api文档的目录存在，源文件所在文件夹名要与包名相同，否则找不到文件。

2 上述命令末尾可以使用源文件名也可以使用包名。例如，源文件名时可以写成  *Monkey.java，支持通配符。

3 -windowtitle、-doctitle后头的字符串如果包含空格，需用" "双引号包含起来，否则系统会当做多个参数执行，最后报错。

示例：javadoc -d apidoc -windowtitle "this is windowtitle" -doctitle "this is doctitle" -header myclass -version -author jtest test

4 @author、@version信息javadoc默认是不会提取的，必须在javadoc命令中指定 -version、-author。

5 如果需要加入程序包的详细描述，需要在存放源文件的文件夹里建立相关包描述的html文件，该文件名通常为package.html。