轉載自? ?MyEclipse生成Javadoc幫助文檔?

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

?

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

一種是嵌入靜態網頁；

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

??

另一種是應用文檔標簽

Sample：

import java.util.*; public class JavaDocTest { public static void main(String[] args){ System.out.print("HelloWorld!"); } }

Javadoc只能為public或者protected成員停止文檔注釋。private和包內訪問的成員的注釋會被忽略掉。那樣做是有道理的，由于只有public和protected成員才能在文檔之外被應用，這也體現了封裝性的優點。

一、利用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

?

二、利用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進行說明。
第二個命令是代碼文件的頭部注釋。一個命令就可以自動地在項目的所有代碼文件中加入頭部注釋，或者替換原來的注釋。
第三個命令為類、方法、屬性加入注釋說明。可以根據模式匹配，自動地根據方法的名稱，建立更為具有可讀性的注釋文本。

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

創作挑戰賽新人創作獎勵來咯，堅持創作打卡瓜分現金大獎

總結

以上是生活随笔為你收集整理的MyEclipse生成Javadoc帮助文档的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。