❶ java高手:javadoc 在哪個文件夾中,它的作用是什麼
在JDK目錄下的bin子目錄中
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標簽可以使你隨時隨地在需要的地方作上標記,不至於遺漏未盡的工作。
❷ 如何在IntelliJ IDEA中生成JavaDoc幫助文檔
我們用IntelliJ IDEA編輯好Java項目以後,一般需要生成一個JavaDoc文檔供相關人員閱讀。那麼如何生成JavaDoc文檔呢?下面小編給大家演示一下。
1、首先我們需要在桌面上新建一個文件夾用於存放JavaDoc的文件,如下圖所示
2、接下來點擊IntelliJ IDEA頂部的Tools菜單,選擇Generate JavaDoc選項,如下圖所示
3、然後在彈出的界面中我們點擊Output directory輸入框後面的按鈕,如下圖所示
4、在彈出的選擇文件夾界面中選擇剛才新建的文件夾,如下圖所示
5、接下來在底部的Locale輸入框配置語言和編碼集,如下圖所示,語言用zh_CN,代表中文
6、然後點擊確定以後我們就等待IntelliJ IDEA給我們生成JavaDoc文檔即可,等到輸出欄出現如下圖所示的提示代表生成完畢
7、接下來我們打開JavaDoc文件夾,找到index.html文件,點擊它,如下圖所示
8、最後我們就可以看到如下圖所示的JavaDoc文檔了,它把項目中所有的類,程序包都給寫到文檔了,非常的詳細
工具/材料
IntelliJ IDEA
❸ Android studio怎麼生成javadoc
一、為代碼生團此成注釋
Android studio 下載javadoc 插件。
選擇要生成注釋的工程,模塊或者Java文件,右鍵選擇如下圖的,JavaDocs ->Create JavaDocs for all elements
javadoc:錯誤-com.sun.tools.doclets.internal.toolkit.util.DocletAbortException:com.sun.tools.javac.code.Symbol$CompletionFailure:找不到java.lang.FunctionalInterface的類文件
❹ Java--cmd--javadoc 就出現這個錯誤,未指定軟體包或類,求解
如果是Tomcat閃退問題可以試一下以下方法:
重點:1。在JAVA_HOME變數里添加jdkin地址和jrein地址
2.創建Tomcat的環境變數:TOMCAT_HOME=E: omcat-6.0.35 (解壓後的tomcat文件目錄)
3.在Path里添加%JAVA_HOME%和%TOMCAT%(注意,在Home里包含了bin文件夾,此處不用再添加in)
然後:
1.在已解壓的tomcat的bin文件夾下找到startup.bat,右擊->編輯。在文件頭加入下面兩行:
SET JAVA_HOME=D:Javajdk1.6.0_10 (java jdk目錄)(你當前的jdk版本)
SET TOMCAT_HOME=E: omcat-6.0.35 (解壓後的tomcat文件目錄)
2.同樣的。在已解壓的tomcat的bin文件夾下找到shutdown.bat,右擊->編輯。在文件頭加入下面兩行:
SET JAVA_HOME=D:Javajdk1.6.0_10 (java jdk目錄)
SET TOMCAT_HOME=E: omcat-6.0.35 (解壓後的tomcat文件目錄)
貌似應該是環境變數的問題,本人親測有效
引用鏈接:網頁鏈接
❺ 將.java生成chm,用easychm可以將圖片和txt和html生成chm文件,如何將.java文件也生成jchm文件呢
你需要先導出自己工程的api,到出後在工程裡面的doc文件夾就會相關的文件,也包括你想轉換的html文件,再用你的easychm轉吧,不行的話建議你下載一個hugechm,導出工程:右鍵工程-->export-->java-->javadoc-->next。第一次導出的話需要你在javadoc command中選擇執行行程序,選擇jdk安裝目錄下bin目錄下的javadoc.exe文件(比如我的:C:\Program Files\Java\jdk1.7.0_45\bin\javadoc.exe),在use standard doclet處選擇導出文件放置的位置,默認就好
,如果用hugechm的話就把導出的doc文件下的index.html放進去,打包就可以了,希望你能幫到你
❻ 如何使用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方法盡管採用了文檔注釋,但注釋內容和方法信息卻沒有出現在幫助文檔中;
❼ intellij idea怎麼設置java幫助文檔
打開idea我引用的jar包都放在
Project Structure——>Moles——>libs文件夾(雙擊)
雙擊jar包所在文件夾,跳出對話框內。
1.如果api對應的javadoc文檔放在本容地,則點擊紅色箭頭所指示的按鈕,選擇javadoc文件夾
2.如果api是網上的,則把網址復制下來,點擊藍色箭頭所指示的按鈕,在彈出的輸入框中寫入對應的api網址
完成後,編寫java代碼的時候有疑問,Ctrl+Q 就會彈出api的介紹了。