資訊專欄INFORMATION COLUMN
摘要：隨著的迅速發(fā)展，如何編寫出更加規(guī)范的文檔說明則顯的尤為重要。你是否還通過手寫的方式來生成和編寫這些文檔呢那么你就啦工欲善其事，必先利其器?？稍诰€實時查看接口的參數(shù)返回和說明，無須手動維護文檔。實現(xiàn)列出所有的文件。
隨著API的迅速發(fā)展，如何編寫出更加規(guī)范的API文檔說明則顯的尤為重要。
你是否還通過手寫的方式來生成和編寫這些文檔呢？
那么你就OUT啦！
工欲善其事，必先利其器。
本文分享一款工具：PHP_DOC。
可在線實時查看API接口的參數(shù)、返回和說明，無須手動維護文檔。
背景
你還在為維護 API文檔 而煩惱嗎？
維護 客戶端 接口。
維護 Rpc 接口。
...
那么問題來了，
能不能根據(jù)代碼進(jìn)行生成API文檔呢？
能不能生成高逼格的界面來進(jìn)行展示呢？
能不能適合不同框架的系統(tǒng)呢？
原理
首先用程序分析代碼的注釋，然后進(jìn)行友好的展示。
實現(xiàn)
（1） 列出所有的API文件。
（2） 點擊文件名，可以查看里面的接口。
（3） 點擊接口名稱，可以查看接口的注釋。
效果圖
圖1
圖2
圖3
圖4
PHP_DOC 實時生成 API 文檔 GIF
如果大家需要下載源碼，可以關(guān)注微信公眾號，回復(fù) “php_doc” 即可。
Thanks ~
系統(tǒng)的講解 - SSO 單點登錄
系統(tǒng)的講解 - PHP WEB 安全防御
系統(tǒng)的講解 - PHP 緩存技術(shù)
系統(tǒng)的講解 - PHP 接口簽名驗證
系統(tǒng)的講解 - PHP 浮點數(shù)高精度運算
文章版權(quán)歸作者所有，未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請注明本文地址：http://www.ezyhdfw.cn/yun/30546.html