javadoc鏈接

『壹』 java的javadoc怎麼用

Javadoc是Sun公司提供的一個技術，它從程序源代碼中抽取類、方法、成員等注釋形成一個和源代碼配套的API幫助文檔。也就是說，只要在編寫程序時以一套特定的標簽作注釋，在程序編寫完成後，通過Javadoc就可以同時形式程序的開發文檔了。
JBuilder提供了多項對Javadoc支持的功能，可以通過向導在工程窗格的樹中創建Javadoc的節點，通過節點的菜單命名創建工程的Javadoc文檔，可以通過誘導的方式錄入Javadoc的標簽，檢驗注釋是否和源代碼相匹配等。
本文，我們將講解如何在源代碼中用Javadoc標簽寫注釋及如何創建Javadoc文檔。
雖然軟體工程中把詳細設計作為軟體項目的一個重要的階段，但在實踐中往往沒有得到落實。並不是這個階段不重要，而是實施有很大的困難，因為軟體需求是天生的易動症患者，好不容易詳細設計出來後，需求已和當初的版本大相徑庭，而花費巨大，精雕細琢的詳細設計已變成昨日黃花了。
Javadoc注釋由Javadoc標簽和描述性文本組成，你可以為類、介面添加註釋，也可為構造函數、值域、方法等類中的元素添加註釋。
可以通過代碼模板快速的錄入Javadoc注釋，你也可以選擇通過Javadoc對話框以一種形象化的方式錄入Javadoc注釋。此外，JBuilder還提供了各種Javadoc的輔助功能，如JavadocInsight誘導錄入，沖突報告和更正，特殊的todo標簽等。
雖然在Java文件中編寫注釋後，馬上可以切換到內容窗格的Doc視圖頁代碼中對應的Javadoc文檔，但在Doc視圖頁中生成的文檔僅是不完整的"範本"。首先，沒有導航樹，其次沒有生成通過@see或@link關聯內容的鏈接。所以你可以把Doc視圖頁中的Javadoc文檔看成是Javadoc最終版本的預覽。
本文中我們介紹了Javadoc的標簽，講解了如何在JBuilder編輯Javadoc注釋，你應該盡量使用JavadocInsight、ClassInsight和ParameterInsight快速而正確地編寫Javadoc注釋。此外你應該將常用的注釋做成模板，方便快速錄入。
JBuilder提供的注釋沖突報告和恢復的功能可以使你輕松解決注釋沖突的問題，免除了單調的手工調整操作。
JBuilder還允許你自定義Javadoc標簽，以滿足一些個性化的要求。此外JBuilder自定義的todo標簽可以使你隨時隨地在需要的地方作上標記，不至於遺漏未盡的工作。

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

代碼如下：

[java]view plain

• /**

• *計算器工具類

• *

• *@authorGaoHuanjie

• *@versionV1.0

• */

• publicclassComputerUtil{

• /*

• *加法運算

• *

• *@parama加數a

• *@paramb加數b

• *@return返回兩個整數的和

• */

• publicstaticintadd(inta,intb){

• returna+b;

• }

• /**

• *減法運算

• *

• *@parama被減數

• *@paramb減數

• *@return返回兩個整數的差

• */

• publicstaticintsubtraction(inta,intb){

• returna-b;

• }

• /**

• *乘法運算

• *

• *@parama因數

• *@paramb因數

• *@return返回兩個整數的乘積

• */

• (inta,intb){

• returna*b;

• }

• /**

• *除法運算

• *

• *@parama被除數

• *@paramb除數

• *@return返回兩個整數的商

• */

• intdivision(inta,intb){

• returna/b;

• }

• /**

• *取余運算

• *

• *@parama被除數

• *@paramb除數

• *@return返回兩個整數的相除後的余數

• */

• privateintresial(inta,intb){

• returna%b;

• }

• }

步驟：

①、打開DOS窗口；

②、定位到到該類的源文件所在文件夾；

③、輸入命令：javadoc -d c:help -author -version ComputerUtil.java

說明：-d：其後空一格，用來指定生成的幫助文檔存放的位置；

-author：用來指定生成的幫助文檔必須顯示該類的作者，如果沒有這一命令則生成的幫助文檔將不會顯示作者；

-version：用來指定生成的幫助文檔必須顯示該類的版本，如果沒有這一命令則生成的幫助文檔將不會顯示版本；

④、點擊回車鍵。

結論：

①、Java中多行注釋分為文檔注釋和非文檔注釋，只有文檔注釋所注釋的內容才會出現在幫助文檔中，非文檔注釋所注釋的內容不會出現在幫助文檔中（比如add方法，由於該方法的注釋是非文檔注釋，所以注釋內容沒有生成到幫助文檔中，只出現了該方法的一些信息）；


②、只有被public和protected修飾的方法添加的文檔注釋的注釋內容才能出現在幫助文檔中，所以division方法和resial方法盡管採用了文檔注釋，但注釋內容和方法信息卻沒有出現在幫助文檔中；

『叄』 如何使用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.exe 是什麼啊

從源程序中提取java文檔，就像我們所看到的 SUN的API文檔一樣，把你的類、方法、變數全部放進去一個超鏈接中，方便用戶查閱。

下面是調試信息：

用法：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> 的包列表鏈接至位於 <url> 的文檔
-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> 輸出編碼名稱

『伍』 java source Attachment 和 javadoc Location 各指什麼它們在哪個文件夾中了謝謝

java
source
Attachment
是尋找源碼，如果Jar包或class文件有源碼的話，指定源碼所在地址就可以專鏈接到源碼。屬javadoc
location
是Java注釋文件可以幫助你查找各個函數和類的注釋，我知道的就這些。

『陸』 eclipse內部Javadoc怎麼漢化成中文

首先到oracle官網jdk/jdk-api-localizations/jdk-api-zh-cn/publish/1.6.0/html_zh_CN.zip下載中文的JavaDOC，版本為javaSE6.0。

然後在Eclipse中選擇內window-->Preferences-->java-->Instralls JRES

然後點擊jre6.0，選擇右容邊的Edit

在彈出的窗體中選擇rt.jar後點擊Javadoc Location：

選擇下面的Javadoc in archive ,在Archive path中選擇下載到的html_zh_CN.zip的路徑，然後點擊Path within archive右邊的Browse

點擊圖中的樹狀結構選擇到api節點為止後，點擊所有的彈出窗體的ok按鈕。

『柒』 怎麼設置，可以使eclipse裡面的api提示變成中文

1. 首先要下載Eclipse的中文api，下載完成後，打開Eclipse軟體，下載鏈接：http://download.java.net/jdk/jdk-api-localizations/jdk-api-zh-cn/publish/1.6.0/html_zh_CN.zip

2. 在【窗口】菜單中找到【首選項】，單擊【首選項】

3. 在【Java】下找到【已安裝的JRE】，點擊裡面【已安裝的JRE】點擊【編輯】，找到/lib/rt.jar選項和/lib/jsse.jar選項，做以下同樣的操作，選中源代碼鏈接->單擊【移除】，選中剛移除選項的下一個選項，然後單擊【Javadoc位置】，單擊【瀏覽】，找到之前下載的Eclipse的中文api，要一直到「api」路徑，然後點擊【確定】，點擊【測試】看看我們選擇的路徑是否正確，若正確點擊【確定】，關閉彈出窗口，再點擊【確定】

4. 對兩個選項都設置完成後，再單擊【確定】，即完成了對Eclipse的全部設置，現在把滑鼠放在代碼上，就會出現中文的提示了。

詳細設置參考鏈接：http://jingyan..com/article/c275f6bacb4425e33d7567b6.html

『捌』 java中如何自動生成注釋

你說的應該是生成javadoc吧?

最簡單方式就是使用命令行, cd到你的項目源代碼目錄下, 輸入如下指令:

javadoc-ddocs-subpackagescom.yourpackage

其中-d docs指定了生成的javadoc在相對目錄docs下, -subpackages com.yourpackage指定了你要被生成javadoc的源代碼包.

JAVADOC是官方提供的一種生成注釋文檔的工具, 他的用法如下:

用法:javadoc[options][packagenames][sourcefiles][@files]
-overview<file>從HTML文件讀取概覽文檔
-public僅顯示public類和成員
-protected顯示protected/public類和成員(默認值)
-package顯示package/protected/public類和成員
-private顯示所有類和成員
-help顯示命令行選項並退出
-doclet<class>通過替代doclet生成輸出
-docletpath<path>指定查找doclet類文件的位置
-sourcepath<pathlist>指定查找源文件的位置
-classpath<pathlist>指定查找用戶類文件的位置
-cp<pathlist>指定查找用戶類文件的位置
-exclude<pkglist>指定要排除的程序包列表
-subpackages<subpkglist>指定要遞歸載入的子程序包
-breakiterator計算帶有BreakIterator的第一個語句
-bootclasspath<pathlist>覆蓋由引導類載入器所載入的
類文件的位置
-source<release>提供與指定發行版的源兼容性
-extdirs<dirlist>覆蓋所安裝擴展的位置
-verbose輸出有關Javadoc正在執行的操作的信息
-locale<name>要使用的區域設置,例如en_US或en_US_WIN
-encoding<name>源文件編碼名稱
-quiet不顯示狀態消息
-J<flag>直接將<flag>傳遞到運行時系統
-X輸出非標准選項的提要

通過標准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>的程序包列表鏈接至位於<url>的文檔
-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的全限定名稱
-tagletpathTaglet的路徑
-charset<charset>用於跨平台查看生成的文檔的字元集。
-helpfile<file>包含幫助鏈接所鏈接到的文件
-linksource以HTML格式生成源文件
-sourcetab<tablength>指定源中每個製表符占據的空格數
-keywords使程序包,類和成員信息附帶HTML元標記
-stylesheetfile<path>用於更改生成文檔的樣式的文件
-docencoding<name>指定輸出的字元編碼