api文檔生成

網(wǎng)上有很多教程,不難,我肯定沒有他們懂,所做的不過是把繁瑣的說明說簡單,簡要話。

先下個工具http://url.cn/PSy9dk

以下面這個項目為例

右鍵

看圖吧

這里選擇java下面的生存javadoc,這個javadoc很多人都用過,就是和網(wǎng)頁差不多

上面是選擇安裝java的javadoc編譯器的位置,很容易找到,套用地址找就是 了。

下面是生成后的文件夾地址

這就生成后以網(wǎng)頁形式的api文檔,大家都用過。一樣的


打開后還能看吧,像那么回事,注釋寫得少,寫好點,就更像了。

繼續(xù)往下看,我們來生成chm格式,都用過。

第一行:剛才生成api文檔的地址,復(fù)制進(jìn)去就是了,第二行,取個名字。后面就全是 y。

如箭頭,生成結(jié)果。直接打開。


很丑,我沒有寫太多注釋,生成api文檔,一定要有標(biāo)準(zhǔn)的,豐富的注釋,不然也是沒啥用的。

這是個引子,還有很多注意的地方,比如說編碼格式啊什么的。大家勇于拓展。

分享個鏈接http://www.csdn.net/article/2013-02-20/2814189-API_DOC_TOOLS

里面也只是介紹了有哪些工具,帶各位大蝦有興趣的深究。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 原文地址:RESTful web API文檔生成器 問:開發(fā)業(yè)務(wù)模塊代碼最重要的是什么?答:API接口文檔 如果你...
    brucewar閱讀 5,028評論 0 51
  • 標(biāo)簽(空格分隔): node.js apidoc可以根據(jù)代碼注釋生成web api文檔,支持大部分主流語言java...
    xun閱讀 113,174評論 23 40
  • 最近一直在整理公司前輩寫的php后臺api模塊。發(fā)現(xiàn)api整理起來還是很麻煩的,而且很不直觀,為此跟app端的開發(fā)...
    成木2016閱讀 7,480評論 5 8
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 136,595評論 19 139
  • 自從上周日晚上,孩子經(jīng)歷了病毒感染,發(fā)燒三天,咳嗽四天至今還沒有完全痊愈的歷程,在一周六天內(nèi)帶孩兒去了四趟醫(yī)院后,...
    荷中仙子閱讀 243評論 1 1

友情鏈接更多精彩內(nèi)容