javadoc,javadoc注釋規範

本文目錄一覽：

• 1、如何使用eclipse生成javadoc幫助文檔
• 2、javadoc的具體使用方法，謝謝
• 3、JDK JavaDoc有什麼用
• 4、如何使用javadoc命令生成api文檔，文檔注釋
• 5、JAVA中JAVADOC是什麼意思？
• 6、如何使用javadoc

如何使用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的具體使用方法，謝謝

用法：javadoc [選項] [軟體包名稱] [源文件] [@file]

-overview 文件 讀取 HTML 文件的概述文檔

-public 僅顯示公共類和成員

-protected 顯示受保護/公共類和成員（默認）

-package 顯示軟體包/受保護/公共類和成員

-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 利用位於 url2 的包列錶鏈接至位於

檔

-excludedocfilessubdir name1:..排除具有給定名稱的所有文檔文件子目

-group name p1:p2..在概述頁面中，將指定的包分組

-nocomment 不生成描述和標記，只生成聲明。

-nodeprecated 不包含 @deprecated 信息

-noqualifier name1:name2:…輸出中不包括指定限定符的列表。

-nosince 不包含 @since 信息

-notimestamp 不包含隱藏時間戳

-nodeprecatedlist 不生成已過時的列表

-notree 不生成類分層結構

-noindex 不生成索引

-nohelp 不生成幫助鏈接

-nonavbar 不生成導航欄

-serialwarn 生成有關 @serial 標記的警告

-tag name:locations:header 指定單個參數自定義標記

-taglet 要註冊的 Taglet 的全限定名稱

-tagletpath Taglet 的路徑

-charset charset 用於跨平台查看生成的文檔的字符集。

-helpfile file 包含幫助鏈接所鏈接到的文件

-linksource 以 HTML 格式生成源文件

-sourcetab tab length 指定源中每個製表符佔據的空格數

-keywords 使包、類和成員信息附帶 HTML 元標記

-stylesheetfile path 用於更改生成文檔的樣式的文件

-docencoding name 輸出編碼名稱

JDK JavaDoc有什麼用

JDK是一個工具包，裡面包括很多高級Java開發時需要用到程序庫和調試工具，比如虛擬機監控工具、內存工具、編碼工具、打包工具、文檔工具等等。其中的javadoc就是文檔工具，用來自動根據代碼中的帶有特定格式的注釋來生成HTML格式的文檔。典型的一個例子就是Java官網的API解釋。這些文檔就是根據Java源代碼中的注釋自動生成的。

如何使用javadoc命令生成api文檔，文檔注釋

使用javadoc命令生成api文檔：

創建java源文件包。java文件都是存放在一個package包中，這樣方便對java文件進行操作和區分，首先在磁碟上創建文件夾一樣的方式創建package包。

創建java源文件。在包下，創建與文件名相同的java源文件，輸入一些文檔注釋，這些文檔注釋用於自動的api文件進行說明使用。

進入java源文件目錄。通過cd等windows命令進入java源文件包所在的磁碟位置。

查看javadoc命令使用說明。如果是第一次使用javadoc命令，可以通過javadoc -help命令查看javadoc使用說明。

開始創建api文件。使用命令輸入javadoc -d javaapi -header 測試的API -doctitle 這是我的第一個文檔注釋 -version -author javadoc/Hello.java 進行文檔生成。-d:文件存儲位置; -head:文件頭部名稱; -version:顯示版本; -author:顯示作者; javadoc/Hello.java 處理的文件包以及java源文件。

查看生成的api文件。創建成功之後，就會自動創建指定的文件夾下生成api文件。打開index.html就是api文件的入口。

JAVA中JAVADOC是什麼意思？

javadoc就是通過源代碼(根據代碼類包等的關係加註釋)生成的api文檔，可以是html的網頁形式也可以打包成chm格式

如何使用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。養成一個好的編程習慣非常重要，何況這並不難。