MyEclipse生成Javadoc幫助文檔

Javadoc是Sun公司提供的一個技術，它從程序源代碼中抽取類、方法、成員等註釋造成一個和源代碼配套的API幫助文檔。也就是說，只要在編寫程序時以一套特定的標籤做註釋，在程序編寫完成後，經過Javadoc就能夠同時形式程序的開發文檔了。

 

Javadoc輸出的是一些靜態網頁文檔，通過WEB瀏覽器來查看它。
Javadoc的語言規則：
全部Javadoc都只能源於結束。應用javadoc有二種方法：

一種是嵌入靜態網頁；

Javadoc將靜態網頁源代碼嵌入到所生成的靜態網頁文檔中。那樣能充分利用靜態網頁的功能。好比：

1.   

另外一種是應用文檔標籤

Sample：

1. import java.util.*;   
2.    
3. public class JavaDocTest {   
5.    
6. public static void main(String[] args){   
7.      System.out.print("HelloWorld!");       
8. }   
9. }  

Javadoc只能爲public或者protected成員中止文檔註釋。private和包內訪問的成員的註釋會被忽略掉。那樣作是有道理的，因爲只有public和protected成員才能在文檔以外被應用，這也體現了封裝性的優勢。

1、利用Myeclipse均可輕鬆製做javadoc

利用Myeclipse生產javadoc文檔的步驟以下：

1.選擇File->Export->javadoc，下一步。

2.Javadoc comand選擇JDK的bin目錄下的javadoc.exe。選擇要生成的源代碼和javadoc保存的目的路徑，下一步。

3.Document title輸入標題，下一步。

4.Extra Javadoc options輸入

-windowtitle 'Type B Monitor'[瀏覽器顯示標題]

-bottom <center>Travelsky</center>[底部顯示文本]，

若是出現編碼錯誤，則填寫如下這句

好比項目採用的是UTF－8的編碼就填：

-encoding UTF-8 -charset UTF-8

 

2、利用3個插件均可輕鬆製做javadoc

JDocEditor,JAutoDoc,Java2Html。三個小工具，輕鬆製做JavaDoc.一個是可見即所得的JavaDoc編輯工具，一個是自動創建代碼註釋的工具，一個是把代碼轉換成Html格式的工具。
JDocEditor:
http://www.certiv.NET/download/downloads.html#jdoceditor
一個所見即所得的Java Doc 編輯器。不用再費神地在代碼中調整註釋的html標記了，能夠自由地編出高質量的帶豐富格式的Java Doc 。

JAutoDoc
http://jautodoc.sourceforge.Net/index.html#download
自動創建Java Doc 文檔。功能十分強大，三個命令實如今全部源代碼中加入完整的Java Doc註釋。一個命令是加入Package的說明文檔，在Package中加入package.html，對package進行說明。
第二個命令是代碼文件的頭部註釋。一個命令就能夠自動地在項目的全部代碼文件中加入頭部註釋，或者替換原來的註釋。
第三個命令爲類、方法、屬性加入註釋說明。能夠根據模式匹配，自動地根據方法的名稱，創建更爲具備可讀性的註釋文本。

Java2Htmlhttp://www.java2html.de/eclipse.html準確地說它不是用來直接創建JavaDoc 的，可是能夠用來創建其餘文檔。它的功能是，把Eclipse中的語法色彩格式轉換成爲Html,讓粘貼到網頁上，或者其餘文檔中的代碼帶有清晰的語法格式。