隨著API的迅速發(fā)展，如何編寫出更加規(guī)范的API文檔說明則顯的尤為重要。

你是否還通過手寫的方式來生成和編寫這些文檔呢？

那么你就OUT啦！

工欲善其事，必先利其器。

本文分享一款工具：PHP_DOC。

可在線實時查看API接口的參數(shù)、返回和說明，無須手動維護文檔。

背景

你還在為維護 API文檔 而煩惱嗎？

維護 客戶端 接口。

維護 Rpc 接口。

...

那么問題來了，

能不能根據(jù)代碼進行生成API文檔呢？

能不能生成高逼格的界面來進行展示呢？

能不能適合不同框架的系統(tǒng)呢？

原理

首先用程序分析代碼的注釋，然后進行友好的展示。

實現(xiàn)

（1） 列出所有的API文件。
（2） 點擊文件名，可以查看里面的接口。
（3） 點擊接口名稱，可以查看接口的注釋。

效果圖

PHP_DOC 實時生成 API 文檔.gif

Thanks ~

如果大家想下載源碼，歡迎大家Q我（留言、私信均可) ~