收集而來加補充 注意本人因開發android而收集增注，有部份內容有可能只適用於eclipse android

//... 行註釋
/*...*/行註釋
/*
 *... 塊註釋
 */
/**
 *... 文件註釋
 *@see 文件標記註釋
 */
//TODO 標籤

三. 使用 javadoc 標記
javadoc 標記由“@”及其後所跟的標記型別和專用註釋引用組成
javadoc 標記有如下一些：
@author 標明開發該類模組的作者
@version 標明該類模組的版本
@see 參考轉向，也就是相關主題 @see 類名 @see 完整類名 @see 完整類名#方法名
@param 對方法中某引數的說明
@return 對方法返回值的說明
@exception 對方法可能丟擲的異常進行說明
@category
@serialData
@deprecated 廢棄的

@author 作者名
@version 版本號
其中，@author 可以多次使用，以指明多個作者，生成的文件中每個作者之間使用逗號 (,) 隔開。@version 也可以使用多次，只有第一次有效

使用 @param、@return 和 @exception 說明方法
這三個標記都是隻用於方法的。@param 描述方法的引數，@return 描述方法的返回值，@exception 描述方法可能丟擲的異常。它們的句法如下：
@param 引數名 引數說明
@return 返回值說明
@exception 異常類名 說明

四. javadoc 命令
用法：
　　javadoc [options] [packagenames] [sourcefiles]

選項：

-public 僅顯示 public 類和成員
-protected 顯示 protected/public 類和成員 (預設)
-package 顯示 package/protected/public 類和成員
-private 顯示所有類和成員
-d <directory> 輸出檔案的目標目錄
-version 包含 @version 段
-author 包含 @author 段
-splitindex 將索引分為每個字母對應一個檔案
-windowtitle <text> 文件的瀏覽器視窗標題

javadoc 編譯文件時可以給定包列表，也可以給出源程式檔案列表。例如在 CLASSPATH 下有兩個包若干類如下：

　　fancy.Editor
　　fancy.Test
　　fancy.editor.ECommand
　　fancy.editor.EDocument
　　fancy.editor.EView

可以直接編譯類：
javadoc fancy\Test.java fancy\Editor.java fancy\editor\ECommand.java fancy\editor\EDocument.java fancy\editor\EView.java
 
也可以是給出包名作為編譯引數，如：javadoc fancy fancy.editor
可以自己看看這兩種方法的區別

到此為止javadoc就簡單介紹完了，想要用好她還是要多用，多參考標準java程式碼

1 註釋文件的格式
註釋文件將用來生成HTML格式的程式碼報告，所以註釋文件必須書寫在類、域、建構函式、方法、定義之前。註釋文件由兩部分組成——描述、塊標記。
前兩行為描述，描述完畢後，由@符號起頭為塊標記注視。
2.1 檔案頭註釋
檔案頭註釋以 /*開始，以*/結束，需要註明該檔案建立時間，檔名，名稱空間資訊。
2.2 類、介面註釋
類、介面的註釋採用 /** … */，描述部分用來書寫該類的作用或者相關資訊，塊標記部分必須註明作者和版本。
2.3 建構函式註釋
建構函式註釋採用 /** … */，描述部分註明建構函式的作用，不一定有塊標記部分。
2.4 域註釋
域註釋可以出現在註釋文件裡面，也可以不出現在註釋文件裡面。用/** … */的域註釋將會被認為是註釋文件熱出現在最終生成的HTML報告裡面，而使用/* … */的註釋會被忽略。
2.5 方法註釋
方法註釋採用 /** … */，描述部分註明方法的功能，塊標記部分註明方法的引數，返回值，異常等資訊。
2.6 定義註釋
規則同域註釋。
3 註釋塊標記
3.1 標記的順序
塊標記將採用如下順序：

*
* @param (classes, interfaces, methods and constructors only)
* @return (methods only)
* @exception (@throws is a synonym added in Javadoc 1.2)
* @author (classes and interfaces only, required)
* @version (classes and interfaces only, required. See footnote 1)
* @see
* @since
* @serial (or @serialField or @serialData)
* @deprecated (see How and When To Deprecate APIs)
* …
一個塊標記可以根據需要重複出現多次，多次出現的標記按照如下順序：
@author 按照時間先後順序（chronological）
@param 按照引數定義順序（declaration）
@throws 按照異常名字的字母順序（alphabetically）
@see 按照如下順序：
@see #field
@see #Constructor(Type, Type...)
@see #Constructor(Type id, Type id...)
@see #method(Type, Type,...)
@see #method(Type id, Type, id...)
@see Class
@see Class#field
@see Class#Constructor(Type, Type...)
@see Class#Constructor(Type id, Type id)
@see Class#method(Type, Type,...)
@see Class#method(Type id, Type id,...)
@see package.Class
@see package.Class#field
@see package.Class#Constructor(Type, Type...)
@see package.Class#Constructor(Type id, Type id)
@see package.Class#method(Type, Type,...)
@see package.Class#method(Type id, Type, id)
@see package
3.2 標記介紹
3.2.1 @param
標記
@param後面空格後跟著引數的變數名字（不是型別），空格後跟著對該引數的描述。
3.2.2 @return
標記
返回為空（void）的建構函式或者函式，@return可以省略。
3.2.3 @throws
標記
@throws以前使用的是@exception。
@throws的內容必須在函式的throws部分定義。
3.2.4 @author
標記
類註釋標記。
函式註釋裡面可以不出現@author。
3.2.5 @version
類註釋標記。
函式註釋裡面可以不出現@version
3.2.6 @since
類註釋標記。
標明該類可以執行的JDK版本
3.2.7 @deprecated
由於某種原因而被宣佈將要被廢棄的方法。
3.2.8 @link
標記
語法：{@link package.class#member label}
Label為連結文字。
package.class#member將被自動轉換成指向package.class的member檔案的URL。

4 HTML程式碼的使用
在註釋描述部分可以使用HTML程式碼。
表示自動標號
需要換行時，不是敲入一個回車符，而是寫入 <br>，如果要分段，就應該在段前寫入 <p>。
文件註釋的正文並不是直接複製到輸出檔案 (文件的 HTML 檔案)，而是讀取每一行後，刪掉前導的 * 號及 * 號以前的空格，再輸入到文件的。