javadoc工具生成本身的API文档

javadoc默认只处理public和protected修饰的内容，若是要提取private，只需在用javadoc时加-private选项。

另外javadoc只处理文档注释即为/**..................*/和只有对处于多个包下面大源文件来生成API文档时，才有概览页面。

javadoc命令的基本用法以下：

javadoc 选项 java源文件/包 选项 -d 生成文件名 -windowtitle 浏览器窗口标题 -doctitle 概述页面标题 -header 页眉 文档注释经常使用以下：

@author

@version

@param

@return

@see

@exception

@throws

不过这些标记大使用是用位置限制的

结合一个例子：

第一类JavadocTest.java

package bb;
/**
 主要入口点
*/
public class JavadocTest
{
	public static void main(String[] args)
	{
		System.out.println("hello!javadoc");
	}
}

第二个类：Test.java

package yee;
/**
  test
  test
  test
*/
public class Test
{
	/**
	 age属性
	*/
	public int age;
	//count
	public int count;
	public Test()
	{

	}
}

命令执行：javaLearn$ javadoc -d apidoc -windowtitle 测试 -doctitle 学习javadoc工具测试api文档 -header 个人类 -encoding UTF-8 -charset UTF-8  *Test.java

若是项目是utf-8,为防止出现乱码，能够加入-encoding UTF-8 -charset UTF-8;

运行结果以下：