本文目錄一覽：
如何使用eclipse生成javadoc幫助文檔
首先，打開Eclipse，在需要生成Javadoc的項目上右擊滑鼠，在彈出來的列表中點擊」導出(O)…「選項。
在彈出來的」導出「窗口中，選擇導出的目標，這裡選擇Java文件夾下的Javadoc，然後點擊」下一步（N）「按鈕。
進入到」選擇生成Javadoc的類型「界面，這裡默認已經配置好了生成Javdoc的javadoc.exe的路徑，如果不對可以重新配置，在「使用標準Doclet(S)」一欄中選擇輸入Javadoc的目錄，默認實在工作空間工程項目下的doc文件夾中，也可以自行配置，然後點擊」下一步（N）「按鈕。
進入到」配置標準doclet的Javadoc自變數「界面，可以根據需要配置Javadoc的自變數，可以通過」基本選項「下的複選框來選擇Javadoc選項。如果想引用一個庫中的類，並且將該庫鏈接到它的javadoc，可以在「選擇應將鏈接生成至的被引用歸檔和項目（R）」列表中選擇，然後點擊「下一步（N）」按鈕。
進入到「配置Javadoc自變數」界面，這裡注意：如果項目採用的是UTF-8編碼，Extra Javadoc options（額外的Javadoc選項）下需要輸入設定參數：-encoding utf-8 -charset utf-8否則生成的網頁中文注釋都是亂碼，點擊「完後」按鈕。
在點擊「完成」按鈕後，會看到Eclipse主界面的「控制台」輸入Javdoc生成成功的信息。
查看生成的Javadoc幫助文檔。
進入到工作空間對應的工程項目下，可以看到有個doc文件夾（當然這是默認的輸出目錄，如果你在生成Javadoc時設置了其它目錄，可以進相應的目錄中）。
點擊進度doc文件夾，會發現doc文件夾中有好多.html文件，打開index.html文件。
可以看到生成的API文檔，這裡面顯示了過程中的相應信息。
點擊其中的類，可以看到相應類的信息，如你設置的版本、作者，還可以看到繼承的類等信息，有助於快速了解源代碼。
如何使用javadoc
package com.frank.chapter1;
// object.Documentation1.java
// TIJ4 Chapter Object, Exercise 13 – 1
/* Run Documentation1.java, Documentation2.java and Documentation3.java
* through Javadoc. Verify the resulting documentation with your Web browser.
*/
/** A class comment */
public class Documentation1 {
/** A field comment */
public int i;
/** A method comment */
public void f() {
}
}
如上一段代碼，使用了javadoc的注釋形式，注釋以/** 開始, 以*/ 結尾，注釋寫在要說明部分的前面。
如何生成javadoc呢？ 很簡單，在eclipse中點擊導航欄中的 project-Generate javadoc 跳出如下界面，然後勾選需要生成文檔的包以及生成文檔的位置就OK啦！~
更詳細的說明見轉載
以下轉自：
通常我們寫java程序可能很少會寫注釋的，但是在公司里真正開發項目的時候。通常都會有嚴格的文檔要求，我這裡談到的不是設計或者測試文檔，而是javadoc。我一直認為javadoc察看起來比MSDN要方便，寫起來同樣不複雜。
javadoc是j2sdk裡面一個非常重要的工具，如果你按照規範在java的源代碼裡面寫好注釋的話，那麼它就可以生成相應的文
檔。開發者察看起來會非常方便。很多IDE都可以直接生成javadoc的，這裡介紹如何寫javadoc以及如何在eclipse下生成
javadoc。
javadoc通常從package、公開類或者介面、公開或者受保護的欄位、公開或者受保護的方法提取信息。每條注釋應該是以/**開始以*/結尾。例如
/**
*
* @param id the coreID of the person
* @param userName the name of the person
* you should use the constructor to create a person object
*/
public SecondClass(int id,String userName)
{
this.id = id;
this.userName = userName;
}
注釋應該寫在要說明部分的前面，如上所示。並且在其中可以包括html的標記，如果上面沒有標記
的話，那麼you should usr the ……將會在javadoc裡面緊跟@param userName….，這樣不是我們希望的。一般注釋可以分為類注釋、方法注釋、欄位注釋等。下面分別作簡單的介紹
類注釋
類注釋應該在import語句的後面在類聲明的前面，比如
package com.north.java;
/**
* @author ming
*
* this interface is to define a method print()
* you should implements this interface is you want to print the username
* @see com.north.ming.MainClass#main(String[])
*/
public interface DoSomething
{
/**
* @param name which will be printed
* @return nothing will be returned
*
*/
public void print(String name);
}
其中@author 和@see都是常用的注釋 第一個表示作者，第二個表示參考的連接。
2.方法注釋
方法注釋要緊靠方法的前面，你可以在其中使用@param @return @throws等標籤。例如
/**
*
* @param i
* @return true if ….. else false
* @throws IOException when reading the file ,if something wrong happened
* then the method will throws a IOException
*/
public boolean doMethod(int i) throws IOException
{
return true;
}
3.欄位注釋
只有public的欄位才需要注釋，通常是static德，例如
/**
* the static filed hello
*/
public static int hello = 1;
在eclipse中我們新建java
project然後編寫幾個介面和類以後就可以用javadoc生成文檔了，從菜單project選擇generate
javadoc，會出現一個嚮導，你按照他的提示一步一步的設定要求，最好他會問你是不是聲稱一個javadoc.xml，如果選擇生成的話，他會在
doc下產生一個javadoc.xml，以後更新文檔的時候你可以直接用ant運行javadoc.xml。選擇完成後你可以發現在project裡面
出現了一個目錄doc裡面就是你的javadoc,想寫出好的javadoc一個非常好的辦法就是多參考java的api
doc。養成一個好的編程習慣非常重要，何況這並不難。
JAVA中JAVADOC是什麼意思？
javadoc就是通過源代碼(根據代碼類包等的關係加註釋)生成的api文檔，可以是html的網頁形式也可以打包成chm格式
JDK JavaDoc有什麼用
JDK是一個工具包，裡面包括很多高級Java開發時需要用到程序庫和調試工具，比如虛擬機監控工具、內存工具、編碼工具、打包工具、文檔工具等等。其中的javadoc就是文檔工具，用來自動根據代碼中的帶有特定格式的注釋來生成HTML格式的文檔。典型的一個例子就是Java官網的API解釋。這些文檔就是根據Java源代碼中的注釋自動生成的。
原創文章，作者：小藍，如若轉載，請註明出處：https://www.506064.com/zh-tw/n/276077.html
微信掃一掃 
支付寶掃一掃 