java生成介面文檔
A. 如何生成javaAPI doc
基本原理是通過jdk\bin\javadoc.exe來生成的。
具體方法,有許多網頁,博客可以參考。
比如
http://www.cnblogs.com/rollenholt/archive/2012/11/13/2767592.html
http://blog.csdn.net/leiming32/article/details/8215957
oracle也有官方文檔。
B. java 開發介面後,有沒有快速生成說明文檔的方法
網頁鏈接
參考這個鏈接
打開java代碼,編寫JavaDoc 注釋,只有按照java的規范編寫注釋,才能很好的生成API文檔,javadoc注釋與普通注釋的區別為多一個*(星號)。普通代碼注釋為/*XXX*/,而javadoc的注釋為/**XXX*/
寫好注釋後
點擊eclipse的【Project】菜單,選擇【Generate JavaDoc】選項。
C. 如何用javadoc生成jdk api
注意:本經驗使用的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就生成了。
D. 如何導出java的api文檔
要知道API文檔有很多版本,有英文版的,也有中文版的,而對於初學者,或者英語不好的同學,可以先看看中文版的!
在文檔的左側,上一部分有很多java包,如果要查看每個包里都有哪些類,介面,直接點擊就可以了。在左側下面一部分會列出包下所有類,介面和其他的一些東西。
若是單獨想要查詢某個方法、介面或類,可以利用索引,按照字母查詢。
例如,要查詢pack(),這個方法的用法和作用。直接點擊字母p,在下面就可以找到了。
單擊pack(),就可以查看到關於pack()的一些內容了!當然,也可以直接在左側的索引里輸入要找的內容進行查找。
E. java api介面文檔生成工具有哪些 支持struts的
Java語言提供了一種強大的注釋形式:文檔注釋。可以將源代碼里的文檔注釋提取成一份系統的API文檔。我們在開發中定義類、方法時可以先添加文檔注釋,然後使用javadoc工具來生成自己的API文檔。文檔注釋以斜線後緊跟兩個星號(/**)開始,以星號後緊跟一個斜線(*/)作為結尾,中間部分全部都是文檔注釋,會被提取到API文檔中。自行搜索一下javadoc即可,示例如下:java">/***類描述**@author作者*@version版本*/publicclassDemoClass{/***內部屬性:name*/privateStringname;/***Setter方法*@returnname*/publicStringgetName(){returnname;}/***Getter方法*@paramname*/publicvoidsetName(Stringname){this.name=name;}}
F. 如何使用javadoc命令生成api文檔,文檔注釋
代碼如下:
[java]view plain
/**
*計算器工具類
*
*@
*@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方法盡管採用了文檔注釋,但注釋內容和方法信息卻沒有出現在幫助文檔中;
G. 怎麼用javadoc生成api文檔
javadoc -d myfill -autor -version api.java
myfill是創建的文檔存放位置,名字隨便起,-autor是作者名 -version是版本號 api.java 是java文檔的路徑內 如果有包要帶上包名,這容里我創建了一個java學習群前面是六六5中間是六一7後邊是150,想學好的可以進來。
H. java api 介面怎麼編寫
Java語言提供了一種強大的注釋形式:文檔注釋。可以將源代碼里的文檔注釋提取成一份系統的API文檔。我們在開發中定義類、方法時可以先添加文檔注釋,然後使用javadoc工具來生成自己的API文檔。
文檔注釋以斜線後緊跟兩個星號(/**)開始,以星號後緊跟一個斜線(*/)作為結尾,中間部分全部都是文檔注釋,會被提取到API文檔中。
自行搜索一下javadoc即可,示例如下:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
/**
* 類描述
*
* @author 作者
* @version 版本
*/
public class DemoClass {
/**
* 內部屬性:name
*/
private String name;
/**
* Setter方法
* @return name
*/
public String getName() {
return name;
}
/**
* Getter方法
* @param name
*/
public void setName(String name) {
this.name = name;
}
}
I. 我用javadoc命令生成api文檔,為什麼用包生成的,和用文件生成的,裡面的構造器的注釋不一樣呢
你的這種情況我沒試過,我一般都是用eclipse自帶的導出api
/***/這種格式,都是會被javadoc獲取的
我猜想,你第一次是多了對包的注釋吧
第二次只是對類的注釋