由於文件註釋適用於生成API文件的，而API文件主要用於說明類、方法、成員變數的功能。因此javadoc工具只處理文件原始檔在類、介面、方法、成員變數、構造器和內部類之前的註釋，忽略其他部分的註釋。而且javadoc工具預設只處理以public或protected修飾的類、介面、方法、成員變數、構造器和內部類之前的文件註釋，如果開發者希望javadoc工具可以提取private修飾的內容，則可以在使用javadoc工具時增加-private選項

文件註釋以斜線後緊跟兩個星號（/**）開始，以星號後緊跟一個斜線（*/）結束，中間部分全部都是文件註釋，會被提取到API文件中。

javadoc命令的基本用法

Javadoc  選項  Java原始檔|包

javadoc命令對原始檔、包生成API文件，在上面的語法格式中，Java原始檔可以支援萬用字元，使用*.java來代表當前路徑下所有的java原始檔。 常用選項:    -d<directory>:該選項指定一個路徑，用於將生成的API文件存放到指定目錄下    -windowtitle<text>:該選項指定一個字串，用於設定API文件的瀏覽器視窗標題    -doctitle<html-code>:該選項制定一個HTML格式的文字，用於指定概述頁面的標題           只有對處於多個包下的原始檔來生成API文件時，才有概述頁面      -header<html-code>>:該選項制定一個HTML格式的文字，包含每個頁面的頁首 可通過Javadoc -help來檢視javadoc命令的所有選項 注：只有對處於多個包下的原始檔來生成API文件時，才有概述頁面 亂碼的情況下需要加    設定原始碼編碼方式：-encoding UTF-8
   指定輸出的字元編碼：-charset UTF-8 例如

package liu;
/**
 *Descriptio
 *<br>網站:<a href="http://www.baidu.com">百度連線</a>
 *<br>Copyright(C),2017-2017,Liu
 *<br>This program is protected by copyright laws.
 *<br>Program Name:
 *<br>Date:
 *@author Liu.zihui 
 
[email protected]
 *@version 1.0
 *
*/
public class JavadocTest
{
   /**
    *簡單測試成員變數
    */
    protected String name;
   /**
    *Test類的測試構造器
    */
   public static void main(String[] args)
   {
      System.out.println("Hello Word!");
   }
}

package xiaohui;
/**
 *Descriptio
 *<br>網站:<a href="http://www.baidu.com">百度連線</a>
 *<br>Copyright(C),2017-2017,Liu
 *<br>This program is protected by copyright laws.
 *<br>Program Name:
 *<br>Date:
 *@author Liu.zihui [email protected]
 *@version 1.0
 *
*/
public class Test
{
   /**
    *簡單測試成員變數
    */
   public int age;
   /**
    *Test類的測試構造器
    */
   public Test()
   {
      
   }
}

在命令列視窗執行命令生成API文件

javadoc -d apiodc -windowtitle test -doctitle study javadoc tool API -header myclass *Test.java

希望javadoc工具生成更詳細的文件資訊，可利用javadoc標記 @author:  作者
@version:  版本
@docroot:  表示產生文件的根路徑
@deprecated:
不推薦使用的方法
@param:  方法的引數型別
@return:  方法的返回型別
@see:  用於指定參考的內容
@exception:
丟擲的異常
@throws:  丟擲的異常，和exception同義。

需要注意這些標記的使用是有位置限制的。
可以出現在類或者介面文件註釋中的標記有：
   @see、@deprecated、@author、@version等。
可以出現在方法或者構造器文件註釋中的標記有：
   @see、@deprecated、@param、@return、@throws、@exception等。
可以出現在文件註釋中的有：
   @see、@deprecated等。 

package xiaohui;
/**
 *Descriptio
 *<br>網站:<a href="http://www.baidu.com">百度連線</a>
 *<br>Copyright(C),2017-2017,Liu
 *<br>This program is protected by copyright laws.
 *<br>Program Name:
 *<br>Date:
 *@author Liu.zihui [email protected]
 *@version 1.0
 *
*/
public class JavadocTageTest
{
   /**
   *一個得到問候語字串的方法
   *@param name 該引數指定向誰問候
   *@return 返回打招呼的字串
   */
   public String hello(String name)
      {
         return name+",你好";
      }
}

在命令列視窗執行命令生成API文件

javadoc -d apiodc -windowtitle test -doctitle study javadoc tool API -header myclass -author -version *Test.java

注：javadoc工具預設不會提取@author和@version兩個標記的資訊，如果要提取這兩個資訊，需要在使用javadoc工具指定-author和-version兩個選項 API文件中的包註釋並不是直接放在java原始檔中，而是必須另外指定，通常通過一個標準的HTML檔案來提供包註釋，這個檔案被稱為包描述檔案，包描述檔案的檔名通常是package.html，並於該包下所有的Java原始檔放在一起，javadoc工具會自動尋找對應的包描述檔案一併提取該報描述檔案中的<body/>元素裡的內容，作為該包的描述資訊 doc針對包生成API

javadoc -d apiodc -windowtitle test -doctitle study javadoc tool API -header myclass -author -version liu xiaohui