前言
程序員一直以來都有一個煩惱,只想寫代碼,不想寫文檔。代碼就表達了我的思想和靈魂。
Python提出了一個方案,叫docstring,來試圖解決這個問題。即編寫代碼,同時也能寫出文檔,保持代碼和文檔的一致。docstring說白了就是一堆代碼中的注釋。Python的docstring可以通過help函數直接輸出一份有格式的文檔,本工具的思想與此類似。
代碼即文檔Apiggs是一個非侵入的RestDoc文檔生成工具。工具通過分析代碼和注釋,獲取文檔信息,生成RestDoc文檔。
引入插件apiggs-gradle-plugin
apiggs-maven-plugin
有這樣一段代碼/** * 歡迎使用Apiggs * @index 1 */ @RestController public class GreetingController { private static final String template = "Hello, %s!"; private final AtomicLong counter = new AtomicLong(); /** * 示例接口 * @param name 名稱 * @return */ @RequestMapping("/greeting") public Greeting greeting(@RequestParam(value="name", defaultValue="apiggs") String name) { return new Greeting(counter.incrementAndGet(), String.format(template, name)); } }運行插件
gradle 運行 task:
Tasks/documentation/apiggs
maven 運行
compile生成文檔
在編譯目錄下生成apiggs文件夾,并生成三個文件:
.json文件,可直接導入postman
.adoc文件,Asciidoc源文件
.html文件,源文件渲染結果,效果如下圖
想了解更多,請查看Wiki
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/71952.html
摘要:在實際開發項目中,有時我們會用到自定義按鈕因為一個項目中,眾多的頁面,為了統一風格,我們會重復用到很多相同或相似的按鈕,這時候,自定義按鈕組件就派上了大用場,我們把定義好的按鈕組件導出,在全局引用,就可以在其他組件隨意使用啦,這樣可以大幅度 在實際開發項目中,有時我們會用到自定義按鈕;因為一個項目中,眾多的頁面,為了統一風格,我們會重復用到很多相同或相似的按鈕,這時候,自定義按鈕組件就...
摘要:代碼整潔之道整潔的代碼不僅僅是讓人看起來舒服,更重要的是遵循一些規范能夠讓你的代碼更容易維護,同時降低幾率。另外這不是強制的代碼規范,就像原文中說的,。里式替換原則父類和子類應該可以被交換使用而不會出錯。注釋好的代碼是自解釋的。 JavaScript代碼整潔之道 整潔的代碼不僅僅是讓人看起來舒服,更重要的是遵循一些規范能夠讓你的代碼更容易維護,同時降低bug幾率。 原文clean-c...
對比內容UCloudStackZStackVMwareQingCloud騰訊TStack華為云Stack優勢總結?基于公有云自主可控?公有云架構私有化部署?輕量化/輕運維/易用性好?政府行業可復制案例輕量化 IaaS 虛擬化平臺?輕量化、產品成熟度高?業內好評度高?功能豐富、交付部署快?中小企業案例多全套虛擬產品及云平臺產品?完整生態鏈、技術成熟?比較全面且健全的渠道?產品成熟度被市場認可,市場占...
摘要:能跨平臺地設置及使用環境變量讓這一切變得簡單,不同平臺使用唯一指令,無需擔心跨平臺問題安裝方式改寫使用了環境變量的常見如在腳本多是里這么配置運行,這樣便設置成功,無需擔心跨平臺問題關于跨平臺兼容,有幾點注意 cross-env能跨平臺地設置及使用環境變量, cross-env讓這一切變得簡單,不同平臺使用唯一指令,無需擔心跨平臺問題 1、npm安裝方式 npm i --save-de...
摘要:引入的模塊引入的使用將打包打包的拆分將一部分抽離出來物理地址拼接優化打包速度壓縮代碼,這里使用的是,同樣在的里面添加 const path = require(path); //引入node的path模塊const webpack = require(webpack); //引入的webpack,使用lodashconst HtmlWebpackPlugin = require(ht...
閱讀 3452·2023-04-25 19:39
閱讀 3800·2021-11-18 13:12
閱讀 3634·2021-09-22 15:45
閱讀 2433·2021-09-22 15:32
閱讀 716·2021-09-04 16:40
閱讀 3728·2019-08-30 14:11
閱讀 1884·2019-08-30 13:46
閱讀 1564·2019-08-29 15:43