參考文章，百度百科

                    http://88250.b3log.org/when-the-little-things-count-javadoc

                    javadoc的檢視幫助文件：http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#serial（可惜是英文的）

                   http://my.oschina.net/u/1415486/blog/339343

                   http://my.oschina.net/u/1415486/blog/339289

                   http://blog.chinaunix.net/uid-725717-id-2060139.html

                   http://my.oschina.net/tiancai/blog/155299

                   http://blog.sina.com.cn/s/blog_6d5c82a70100omah.html  javadoc命令和器options【選項】

Java中有三種註釋方式：

①單行註釋，符號://註釋內容

②段落註釋，即多行註釋，符號:/*註釋內容*/

③文件註釋，用於生成HTML格式的API（Application Program Interface,應用程式介面）註釋文件，符號:/**註釋內容*/

文件註釋根據它所註釋的內容，分為3類：變數，方法和類。也就是說，類的註釋一定要出現在類定義的前面；變數註釋要出現在變數定義的前面；而方法註釋則要出現在方法定義的前面。註釋和定義之間不能有任何東西。

javadoc，顧名思義即java檔案的文件，也就是我們常見的文件，開啟javadoc檔案的話如下圖

dos生成命令：F:\java>-d 檔案儲存目錄 javadoc javadoc.java,格式為：檔案所在目錄：javadoc用法：javadoc [選項] [軟體包名稱] [原始檔] [@file]

注：檔案所在目錄必須填寫完整，此處會儲存在指定的資料夾中，當然javadoc還有很多命令。

eclipse下生成：File->Export->java->javadoc 然後一步一步的來。

注：javadoc command框中填寫 C:\Program Files\Java\jdk1.6.0_43\bin\javadoc.exe 本人的jdk安裝在c盤啦。

dos下生成javadoc的常用命令：請看這篇文章http://blog.chinaunix.net/uid-725717-id-2060139.html

生成過程中可能出現的錯誤：”編碼 GBK 的不可對映字元“，這是因為中文註釋的問題。http://my.oschina.net/tiancai/blog/155299

eclipseFile->Export->java->javadoc，選中專案後不要直接finish，一直next 最後一步VM中新增如下程式碼-encoding utf-8 -charset utf-8

dos下如何處理，請搜javadoc命令即可，解決方法如下:

F:\java>-d 檔案儲存目錄 -encoding UTF-8 -charset UTF-8 javadoc javadoc.java

java檔案中常用的幾個標記，標記後面還可以新增html 的標籤<h3>html字號標籤</h3><a href="www.kengni.com">加入的html的超連結</a>

標籤	說明	JDK 1.1 doclet	標準doclet	標籤型別
@author 作者	作者標識	√	√	包、 類、介面
@version 版本號	版本號	√	√	包、 類、介面
@param 引數名 描述	方法的入參名及描述資訊，如入參有特別要求，可在此註釋。	√	√	建構函式、 方法
@return 描述	對函式返回值的註釋	√	√	方法
@deprecated 過期文字	標識隨著程式版本的提升，當前API已經過期，僅為了保證相容性依然存在，以此告之開發者不應再用這個API。	√	√	包、類、介面、值域、建構函式、 方法
@throws異常類名	建構函式或方法所會丟擲的異常。	√	建構函式、 方法
@exception 異常類名	同@throws。	√	√	建構函式、 方法
@see 引用	檢視相關內容，如類、方法、變數等。	√	√	包、類、介面、值域、建構函式、 方法
@since 描述文字	API在什麼程式的什麼版本後開發支援。	√	√	包、類、介面、值域、建構函式、 方法
{@link包.類#成員 標籤}	連結到某個特定的成員對應的文件中。	√	包、類、介面、值域、建構函式、 方法
{@value}	當對常量進行註釋時，如果想將其值包含在文件中，則通過該標籤來引用常量的值。	√(JDK1.4)	靜態值域

此外還有@serial、@serialField、@serialData、{@docRoot}、{@inheritDoc}、{@literal}、{@code} {@value arg}幾個不常用的標籤，由於不常使用，我們展開敘述，感興趣的讀者可以檢視幫助文件。

在java檔案中如何使用javadoc，請看如下程式碼例項，當然此處僅供參考，主要是列出常見的，其實這是極不規範。

package com.yue.test;

import java.io.IOException;

public class JavaDocTest {

	/**
	 * 
	 * @Title: main 
	 * @param args 
	 * void 
	 * @author shimy
	 * @since 2016-5-3 V 1.0
	 */
	public static void main(String[] args) {
		try {
			new JavaDocTest().javaDocTest("javadoc");
		} catch (IOException e) {
			e.printStackTrace();
		}
	}
	
	/**
	 * 
	 * @ClassName: MyTestInClass 
	 * @Description: TODO 
	 * @author shimy
	 * @date 2016-5-3 上午8:49:11 
	 *
	 */
	private class MyTestInClass{
		/**
		 * 
		 * @Title: inTest  
		 * void 
		 * @author shimy
		 * @since 2016-5-3 V 1.0
		 */
		private void inTest(){
			try {
				new JavaDocTest().javaDocTest("javadoc");
			} catch (IOException e) {
				// TODO Auto-generated catch block
				e.printStackTrace();
			}
		}
	}
	/**
	 * @author <h5>Administrator(作者)</h5>
	 * @version v1.1 (版本號)
	 * @Title: javaDocTest(方法名)
	 * @param javaDocName(引數名 描述)
         * @return  String(對函式返回值的註釋)
	 * @deprecated 過期文字，不建議使用，將來可以摒棄，加入此標記後可以看到我們的javaDocTest方法劃上了橫槓
	 * @throws @throws IOException(異常類名)
	 * @exception IOException 異常類名
	 * {@hide} (註明此方法為隱藏方法，其他物件呼叫不出來，僅供此類和此類的內部類呼叫,看上面)
	 * @see MyTestInClass#inTest() #inTest() 引用,引用的別的類的方法或引數
	 * @since 2016-5-3 V 1.0(描述文字,API在什麼程式在什麼版本後開發支援)
	 * {@link com.yue.test.JavaDocTest#javaDocTest(String)}[連結到某個特定的成員對應的文件中(填寫格式：包.類#成員 標籤),此處連結到自己的方法]
	 * {@value 型別String}(對函式返回值的註釋)
	 * 下面幾個不常用
	 * @serial 可序列化(可序列化)檔案命令
	 * @serialField 
	 * @serialData
	 * {@docRoot}
	 * {@inheritDoc}
	 * {@literal}
	 * {@code} 
	 * 
	 */
	private String javaDocTest(String javaDocName) throws IOException{
		new MyTestInClass().inTest();
		return javaDocName;
	}
}

經過上面的程式碼，我發現並沒有生成自己想要的javadoc，我的自定方法和引數沒有在javadoc下出現，這也正是需要注意的地方。
請看下圖紅色標註，大家制定許可權就可以啦，至於dos命令F:\java>-d 檔案儲存目錄 -public  javadoc javadoc.java(藍色標註為許可權)，點選開啟連結，此處不做陳述。

做一下記錄，來自http://blog.sina.com.cn/s/blog_6d5c82a70100omah.html，大家也可以看javadoc幫助文件

開啟命令列視窗，輸入命令生成api文件。
轉到目錄：D:\Downloads\swt-3.5.2-win32-win32-x86\src，輸入如下命令生成文件。
javadoc -d [email protected]
注：api表示幫助文件的存放目錄名，@package.txt表示以檔案的形式傳入包名。

附錄1：javadoc命令語法。
在命令列輸入javadoc回車就會出現如下的幫助資訊：

javadoc用法：javadoc [選項] [軟體包名稱] [原始檔] [@file]
-overview<檔案>         讀取 HTML 檔案的概述文件
-public                  僅顯示公共類和成員 //帶有public修飾符
-protected               顯示受保護/公共類和成員（預設） //帶有protected、public修飾符
-package                 顯示軟體包/受保護/公共類和成員 //不帶修飾符，或帶有protected、public修飾符
-private                 顯示所有類和成員 //不帶修飾符，或帶有任何修飾符
-help                    顯示命令列選項並退出
-doclet<類>             通過替代 doclet 生成輸出
-docletpath<路徑>       指定查詢 doclet 類檔案的位置
-sourcepath<路徑列表>   指定查詢原始檔的位置
-classpath<路徑列表>    指定查詢使用者類檔案的位置
-exclude<軟體包列表>    指定要排除的軟體包的列表
-subpackages <子軟體包列表>指定要遞迴裝入的子軟體包
-breakiterator           使用 BreakIterator 計算第 1 句
-bootclasspath <路徑列表>覆蓋引導類載入器所裝入的類檔案的位置
-source<版本>           提供與指定版本的源相容性
-extdirs<目錄列表>      覆蓋安裝的擴充套件目錄的位置
-verbose                 輸出有關 Javadoc 正在執行的操作的訊息
-locale<名稱>           要使用的語言環境，例如 en_US 或 en_US_WIN
-encoding<名稱>         原始檔編碼名稱
-quiet                   不顯示狀態訊息
-J<標誌>                 直接將 <標誌> 傳遞給執行時系統

通過標準 doclet 提供:
-d<directory>                   輸出檔案的目標目錄
-use                             建立類和包用法頁面
-version                         包含 @version 段
-author                          包含 @author 段
-docfilessubdirs                 遞迴複製文件檔案子目錄
-splitindex                      將索引分為每個字母對應一個檔案
-windowtitle<text>              文件的瀏覽器視窗標題
-doctitle<html-code>            包含概述頁面的標題
-header<html-code>              包含每個頁面的頁首文字
-footer<html-code>              包含每個頁面的頁尾文字
-top   <html-code>              包含每個頁面的頂部文字
-bottom<html-code>              包含每個頁面的底部文字
-link<url>                      建立指向位於 <url> 的 javadoc 輸出的連結
-linkoffline <url><url2>