將JavaDoc注釋生成API文檔的操作
將JavaDoc 注釋 生成API文檔
1. 打開java代碼，編寫JavaDoc 注釋，只有按照java的規(guī)范編寫注釋，才能很好的生成API文檔，javadoc注釋與普通注釋的區(qū)別為多一個*（星號）。普通代碼注釋為/*XXX*/，而javadoc的注釋為/**XXX*/
2. javadoc注釋要盡量寫的詳細(xì)，這樣別人在沒有源碼的情況下才知道如
何使用您的代碼。
3. 點擊eclipse的【Project】菜單，選擇【Generate JavaDoc】選項。
4.
（1）選擇您要生成JavaDoc的工程
（2）選擇哪些級別的內(nèi)容生成JavaDoc，默認(rèn)為public，如果選擇private則會全部內(nèi)容都生成。
（3）選擇doc的生成位置，默認(rèn)為工程目錄下，建議不要修改。
（4）點擊【Next】按鈕
5.
（1）勾選Document Title，然后填寫文檔標(biāo)題。
（2）點擊【Next】按鈕
6.
（1）選擇使用的jdk版本（看自己的版本是多少就選擇多少）
（2）點擊【Finish】按鈕
7. 可以看到控制臺輸出生成javadoc的信息。
8. 項目下生成一個【doc】的目錄，里面存放著javadoc文檔。
9. 打開doc目錄，用瀏覽器打開index.html
10. 可以看到一個完整的API文檔、javadoc就生成了。
java自動api文檔生成Yapi
開發(fā)過程中，接口文檔是前后端，測試交互的依據(jù)，文檔更新的及時性和準(zhǔn)確性很重要。
word文檔缺點
- 手動編寫，出錯性很高
- 文檔可讀性差，考驗編寫者的耐心
- 無法在線調(diào)試
- 及時性差
swwager文檔缺點
- 文檔可讀性差
- 針對需要帶授權(quán)token的請求，無法在線調(diào)試
- 無法導(dǎo)入和導(dǎo)出api文檔
- 測試和開發(fā)無法在文檔上溝通
Yapi解決以上所有問題，yapi可以支持java apidoc ,兼容swwager，只需要idea安裝對應(yīng)插件，就可以實現(xiàn)右鍵點擊upload to yapi，自動生成api接口文檔
@ApiOperation("管理員創(chuàng)建用戶")
@ApiImplicitParams({
@ApiImplicitParam(paramType = "header", name = "Authentication", dataType = "String", required = true, value = "用戶token")
})
@PostMapping("/users/user")
public CommonResult<UserCreateResponse> createUser(@Validated @RequestBody UserAddRequest userAddRequest) {
Assert.isTrue(userAddRequest != null, "invalid userAddRequest");
return CommonResult.ok(userService.addUser(userAddRequest));
}
Yapi使用，官方教程
以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關(guān)文章
Idea?編譯并運(yùn)行?Spark?3.1.1?源碼的方法
這篇文章主要介紹了Idea?編譯并運(yùn)行?Spark?3.1.1源碼,本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下2022-11-11
如果有?個操作，多次執(zhí)?與?次執(zhí)?所產(chǎn)?的影響是相同的，我們就稱這個操作是冪等的。當(dāng)出現(xiàn)消費者對某條消息重復(fù)消費的情況時，重復(fù)消費的結(jié)果與消費?次的結(jié)果是相同的，并且多次消費并未對業(yè)務(wù)系統(tǒng)產(chǎn)?任何負(fù)?影響，那么這整個過程就可實現(xiàn)消息冪等2023-02-02
SpringBoot 如何根據(jù)不同profile選擇不同配置
這篇文章主要介紹了SpringBoot 如何根據(jù)不同profile選擇不同配置的操作方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-08-08
這篇文章主要介紹了java中map與實體類的相互轉(zhuǎn)換操作，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-07-07
這篇文章詳細(xì)的介紹了java限流算法常用到的算法計數(shù)算法、漏桶算法、令牌桶等算法的相關(guān)資料,需要的朋友可以參考下文，希望本篇文章能幫助到您2021-09-09
一文詳解java如何實現(xiàn)鏈?zhǔn)秸{(diào)用
從?Java?8?開始,便引入了一種稱為“流式?API”的編程風(fēng)格,當(dāng)然也被稱為“鏈?zhǔn)皆O(shè)置”或“鏈?zhǔn)秸{(diào)用”,本文主要來和大家討論一下如何實現(xiàn)鏈?zhǔn)秸{(diào)用,感興趣的可以了解下2023-12-12
這篇文章主要為大家介紹了druid?return行為源碼示例解析,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-09-09
這篇文章主要為大家介紹了Java的SPI機(jī)制以及基于SPI編程示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-08-08
這篇文章主要介紹了Kryo序列化及反序列化用法示例，小編覺得挺不錯的，這里分享給大家，需要的朋友可以參考下。2017-10-10
最近做項目遇到需要將json類型的配置文件引用到項目中,已經(jīng)將讀取json文件的方法封裝成工具類,下面這篇文章主要給大家介紹了關(guān)于SpringBoot讀取資源目錄中JSON文件的相關(guān)資料,需要的朋友可以參考下2023-04-04