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;

運行結果以下：