代碼撰寫的最大問題，大概就是對文檔的維護了，如果文檔與代碼是分離的，那麼在每次修改代碼的時候，都需要修改幫助文檔，這將是一件非常乏味的事情。解決辦法也很簡單，就是生成幫助文檔，將代碼與文檔鏈接起來。幫助文檔的形式可以使che和HTML等多種，下面我們就來學習下使用Eclipse生成HTML的幫助文檔。
我們使用Eclipse編寫代碼的時候，經常會出現一個這樣的註釋代碼模板：
這個就是用來生成HTML幫助文檔的。他是利用JDK的bin目錄下的javadoc生成的。javadoc程序是專門用來生成幫助文檔的一個程序。下面對javadoc命令進行一個簡單的介紹：
語法：
所有的javadoc命令都只能在“/**”（這裏注意，跟普通的註釋有點區別的是這裏的*號是兩個）註釋中出現，和通常的，註釋結束於“*/”。使用javadoc的方式主要有兩種：嵌入式HTML，或者使用“文檔標籤“。獨立文檔標籤是以”@“字符開頭的命令，且要置於註釋行的最前面（緊接”*“之後，像Eclipse幫我們生成的格式一樣）。而”行內文檔標籤“可以出現在javadoc註釋中的任何地方,他們是以”@“字符開頭，但要在花括號內。
可以註釋的地方分爲：域、類、方法。
域註釋位於域定義之前，同樣，類註釋和方法註釋也分別位於類和方法定義的前面。
注意：在private方法前面的註釋會被忽略掉，除非用-private進行標記
嵌入式HTML
HTML和普通的HTML語法基本一樣，不過不要在裏面使用<h1~h6>，因爲javadoc會插入自己的標題。
標籤示例
-
@see：引用其他類
- {@link package.calss#member label}:與@see相似，但是他位於行內
- {@docRoot}：改標籤產生到文檔根目錄的相對路徑，用於文檔樹頁面的顯示超鏈接。
- {@inheritDoc}：改標籤從當前這個類的最直接基類中繼承相關文檔到當前的文檔註釋中。
- @version：說明版本信息。
- @author：這個是比較常用的一個標籤，用來說明作者。
- @since：改標籤允許你指定代碼最早使用的版本。
- @param：參數標籤，這個也是比較常用的一個標籤
- @return：返回值標籤
- @throws：異常標籤
示例
代碼
首先編寫代碼，根據上面的語法寫一個基本的Demo
流程圖解
然後我們右擊工程下的類文件，選擇export導出。
找到java中的javadoc，也可以直接搜索
然後一路下一步，勾選你要生成哪些文件的幫助文檔。
生成之後我們到項目路徑src同級的doc目錄下找到index.html，打開我們編譯的文檔就完成了，如圖。
