正文

自動(dòng)生成api接口文檔（自動(dòng)生成api接口文檔的框架）

發(fā)布時(shí)間：2023-06-01 10:09:36 稿源：創(chuàng)意嶺閱讀： 53

大家好！今天讓創(chuàng)意嶺的小編來大家介紹下關(guān)于自動(dòng)生成api接口文檔的問題，以下是小編對此問題的歸納整理，讓我們一起來看看吧。

開始之前先推薦一個(gè)非常厲害的Ai人工智能工具，一鍵生成原創(chuàng)文章、方案、文案、工作計(jì)劃、工作報(bào)告、論文、代碼、作文、做題和對話答疑等等

只需要輸入關(guān)鍵詞，就能返回你想要的內(nèi)容，有小程序、在線網(wǎng)頁版、PC客戶端和批量生成器

問友Ai官網(wǎng)：https://ai.de1919.com。

本文目錄:

java api接口文檔編寫
如何試用eclipse 生成API幫助文檔？
如何優(yōu)雅的“編寫”api接口文檔
如何優(yōu)雅的生成接口文檔？

自動(dòng)生成api接口文檔（自動(dòng)生成api接口文檔的框架）

java api接口文檔編寫

Java語言提供了一種強(qiáng)大的注釋形式：文檔注釋。可以將源代碼里的文檔注釋提取成一份系統(tǒng)的API文檔。我們在開發(fā)中定義類、方法時(shí)可以先添加文檔注釋，然后使用javadoc工具來生成自己的API文檔。

文檔注釋以斜線后緊跟兩個(gè)星號（/**）開始，以星號后緊跟一個(gè)斜線（*/）作為結(jié)尾，中間部分全部都是文檔注釋，會(huì)被提取到API文檔中。

自行搜索一下javadoc即可，示例如下：

/**
* 類描述
*
* @author 作者
* @version 版本
*/
public class DemoClass {
/**
* 內(nèi)部屬性：name
*/
private String name;

/**
* Setter方法
* @return name
*/
public String getName() {
return name;
}
/**
* Getter方法
* @param name
*/
public void setName(String name) {
this.name = name;
}
}

如何試用eclipse 生成API幫助文檔？

你已經(jīng)完成了,95%的工作了.
就差最后這一哆嗦了.
話說,學(xué)java的那個(gè)不認(rèn)識(shí)"谷老師"這是他給我的答案
方法有三：
1.選擇工程，在菜單Project->Genarate Javadoc
2.選擇工程，鼠標(biāo)右鍵菜單Export ，選擇Java 下面的Javadoc ，點(diǎn)”next” 按鈕
3.選擇工程，在菜單File->Export ，選擇Java 下面的Javadoc ，點(diǎn)”next” 按鈕
然后，可以選擇生成到Javadoc 文檔中的內(nèi)容( 一般選public 或protected) ，選存放目錄( 默認(rèn)即可) ，next下一步 ,此頁全默認(rèn)即可，再next 下一步。
此時(shí)如果項(xiàng)目采用的是 UTF － 8 的編碼，一定要在這一頁的Extra Javadoc options 中加” -encoding UTF-8 -charset UTF-8 〃。否則生成的網(wǎng)頁中文注釋都是亂碼。點(diǎn) Finish 完成,
在工程的doc 目錄中，就有Javadoc 文檔了。

如何優(yōu)雅的“編寫”api接口文檔

1. 拼寫要準(zhǔn)確
接口函數(shù)一旦發(fā)布就不能改了，要保持兼容性，拼寫錯(cuò)誤也不能改了，所以要仔細(xì)檢查拼寫，否則會(huì)被同行嘲笑很多年。
著名悲劇：unix 的 creat
2. 不僅是英文單詞不要拼錯(cuò)，時(shí)態(tài)也不要錯(cuò)。
比如：
返回bool的判斷函數(shù)，單數(shù)要用 is 復(fù)數(shù)要用are，這樣你的命名就和文檔中的描述保持了一致性。
表示狀態(tài)的變量或者函數(shù)要注意時(shí)態(tài)，比如 onXxxxChanged 表示xxx已經(jīng)變化了，isConnecting表示正在連接。
正確的時(shí)態(tài)可以給使用者傳遞更豐富的信息。
3. 函數(shù)最好是動(dòng)賓結(jié)構(gòu)
動(dòng)賓結(jié)構(gòu)就是 doSomething，這樣的函數(shù)命名含義明確
比如： openFile, allocBuffer, setName
如果這個(gè)函數(shù)的動(dòng)詞賓語就是這個(gè)對象本身，那么可以省略掉賓語
4. 屬性命名最好是定語+名詞
比如 fileName, maxSize, textColor
5. 不要用生僻單詞，這不是秀英語的地方，也不要用漢語拼音
比如：rendezvous，估計(jì)大多數(shù)人要去查詞典才知道什么意思，這個(gè)詞源自法語，是約會(huì)的意思。
Symbian OS里有個(gè)用它命名的函數(shù)，開發(fā)Symbian的是英國人，也許人家覺得很平常吧，反正我是查了詞典才知道的。
6. 不要自己發(fā)明縮寫
除非是約定俗成已經(jīng)被廣泛使用的縮寫，否則老老實(shí)實(shí)用完整拼寫。
壞例子: count->cnt, manager->mngr password->pw button->btn
現(xiàn)代的IDE都有很好的自動(dòng)完成功能，名字長一點(diǎn)沒關(guān)系的，可讀性更重要。
7. 保持方法的對稱性，有些方法一旦出現(xiàn)就應(yīng)該是成對的，
比如有open就要有close，有alloc就要有free，有add就要有remove，這些單詞基本是固定搭配的，使用者就很容易理解。
如果 open對應(yīng)clear就有點(diǎn)讓人困惑了。

自動(dòng)生成api接口文檔（自動(dòng)生成api接口文檔的框架）