⑴ eclipse怎麼生成javadoc
方法/步驟
1
注意:本經驗使用的eclipse版本為
Eclipse Java EE IDE for Web Developers.
Version: Luna Service Release 1 (4.4.1)
Build id: 20140925-1800
打開java代碼,編寫JavaDoc 注釋,只有按照java的規范編寫注釋,才能很好的生成API文檔,javadoc注釋與普通注釋的區別為多一個*(星號)。普通代碼注釋為/*XXX*/,而javadoc的注釋為/**XXX*/
javadoc注釋要盡量寫的詳細,這樣別人在沒有源碼的情況下才知道如何使用您的代碼。
點擊eclipse的【Project】菜單,選擇【Generate JavaDoc】選項。
(1)選擇您要生成JavaDoc的工程
(2)選擇哪些級別的內容生成JavaDoc,默認為public,如果選擇private則會全部內容都生成。
(3)選擇doc的生成位置,默認為工程目錄下,建議不要修改。
(5)點擊【Next】按鈕
(1)勾選Document Title,然後填寫文檔標題。
(2)點擊【Next】按鈕
(1)選擇使用的jdk版本
(2)點擊【Finish】按鈕
可以看到控制台輸出生成javadoc的信息。
項目下生成一個【doc】的目錄,裡面存放著javadoc文檔。
打開doc目錄,用瀏覽器打開index.html
可以看到一個完整的API文檔、javadoc就生成了。
⑵ 如何在eclipse中,為整個工程生成javadoc文檔
1、在項目列表中按右鍵,選擇Export(導出),然後在Export(導出)對話框中選擇java下的javadoc,提交到下一步。 在Javadoc Generation對話框中有兩個地方要注意的: javadoc command:應該選擇jdk的bin/javadoc.exe destination:為生成文檔的保存路徑,可自由選擇。 按finish(完成)提交即可開始生成文檔。 2、用菜單選擇:File-Export(文件-導出), 剩下的步驟和第一種方法是一樣的。 3、選中要生成文檔的項目,然後用菜單選擇, Project-Generate Javadoc直接進入Javadoc Generation對話框,剩餘的步驟就和第一種方法在Javadoc Generation對話框開始是一樣的。 呵呵,方便的生成了有用的文檔。真是個好用的功能啊。 所以,平時寫東西的時候要注意寫注釋啊
⑶ 如何解決eclipse與javadoc
1、在項目列表中按右鍵,選擇Export(導出),然後在Export(導出)對話框中選擇java下的javadoc,提交到下一步。在Javadoc Generation對話框中有兩個地方要注意的:javadoc command:應該選擇jdk的bin/javadoc.exedestination:為生成文檔的保存路...
⑷ Eclipse中的這個@javadoc窗口是什麼作用
可以看到當前代碼生成的javadoc怎麼樣。打開它。然後在代碼里隨便選一個方法,就會把該方法的javadoc顯示出來,當然,如果你沒有寫過該方法的javadoc,你什麼也不會得到。
⑸ 如何在eclipse 中設置自動添加Javadoc注釋
在eclipse 中設置自動添加來Javadoc注釋
1.首先自打開eclipse,然後隨意打開一個java類文件,最好找一個沒有注釋的類,方便實踐一下;
2. 在已經打開的eclipse中,點擊頂部工具欄中的window目錄下的perference按鈕,進入perference窗體;
3. 在perference窗體的左邊欄中,輸入Code Templates ,按回車鍵回車,就能快速定位到Code Templates;
4. 在Code Template 中找到comment目錄,該目錄下就是有關注釋的相關代碼風格設置,這里有各種類型,欄位,類型,構造方法以及繼承的方法,這裡面已經是系統默認的注釋,你可以點擊edit按鈕自行定義,現在重要的是點擊下面的勾選按鈕進行勾選,然後保存設置;
5. 在eclipse代碼編輯區域,選中一方法,該方法實現了某介面定義的方法,像圖中所示選中它,按快捷鍵Shift+Alt+J;
6.經過上面的快捷鍵操作,就能看到,Javadoc注釋的代碼已經自動添加到編輯方法體上面,方便以後開發的閱讀,提高效率!
⑹ 如何使用eclipse生成javadoc幫助文檔
右擊你的項目--》Export--》java--》javadoc--》next出現如下頁面
點擊上圖的Configure按鈕,進入到安裝jdk的目錄,選擇bin目錄先的javadoc.exe文件。點擊next到下一步,再點擊next到達
在文本框中輸入如圖所示的「-encoding UTF-8 -charset UTF-8」點擊finish。完成操作。(如果你項目的編碼是utf-8的話。默認應該是GBK。
注意事項,安卓需要將對應的android.jar包導入到項目中才能夠成功的生成javadoc
⑺ eclipse怎樣生成javadoc
使用eclipse生成文檔(javadoc)主要有三種方法:
1,在項目列表中按右鍵,選擇Export(導出),然回後在Export(導出)對話框中選擇java下的答javadoc,提交到下一步。
在Javadoc Generation對話框中有兩個地方要注意的:
javadoc command:應該選擇jdk的bin/javadoc.exe
destination:為生成文檔的保存路徑,可自由選擇。
按finish(完成)提交即可開始生成文檔。
2,用菜單選擇:File->Export(文件->導出),
剩下的步驟和第一種方法是一樣的。
3,選中要生成文檔的項目,然後用菜單選擇,
Project->Generate Javadoc直接進入Javadoc Generation對話框,剩餘的步驟就和第一種方法在Javadoc Generation對話框開始是一樣的。
⑻ 如何在eclipse添加javadoc
假設源代碼在 C:\src 目錄下,其中 com.liigo 是主包,其下可能有數十個子包,數百(千)個Java文件。目錄結構大約是這樣的:
- C:\
| src\
| com\
| liigo\
| ***
怎麼才能以最簡捷的方式生成所有的API文檔呢?
c:\>
c:\>cd src
c:\src>javadoc -d doc -subpackages com.liigo
這樣就搞定了,最終生成的API文檔位於 c:\src\doc 目錄(該目錄是由javadoc.exe自動生成的)。
上面的用法利用了「當前目錄」和「相對路徑」,當然也可以用絕對路徑:
...>javadoc -d c:\doc -sourcepath c:\src -subpackages com.liigo
最終生成的API文檔位於 c:\doc 目錄(該目錄同樣是由javadoc.exe自動生成的)。
總結一下:
我們只用到了javadoc的三個參數: -d,-subpackages,-sourcepath,其中:
參數 說明
-d 指定API文檔的輸出目錄,默認是當前目錄。建議總是指定該參數。
-sourcepath 指定源代碼路徑,默認是當前目錄。 此參數通常是必須的。
-subpackages 以遞歸的方式處理各子包。關鍵參數!如果不使用本參數,每次只能處理一個子包(或需手工列出所有子包)。
註:以上示例要求 javadoc.exe 所在路徑位於系統環境變數「PATH」中。
補充一點:
使用參數 -author 可以將作者信息(@author ***)導出到最終生成的API文檔中, -version 可以生成版本信息。如果是自己寫的一個包,千萬不要忘了用 -author 哦:)
最終完整的命令行是:
...>javadoc -d c:\doc -sourcepath c:\src -subpackages com.liigo -author -version
⑼ eclipse怎麼載入javadoc
方法如下: 1. Window->Pereferences...打開參數選擇對話框,展開Java節點,單擊「InstalledJREs",此時右邊窗口會顯示已經載入的jre。 2. 選中要設置的jre版本,單擊"Edit",彈出JRE編輯窗口 3. 添加javadoc:將JREsystem libraries下的所有包選...