PHP_DOC 實時生成 API 文檔 | 掘金技術徵文

隨着API的迅速發展，如何編寫出更加規範的API文檔說明則顯的尤其重要。

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

那麼你就OUT啦！

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

本文分享一款工具：PHP_DOC。

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

背景

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

維護 客戶端 接口。

維護 Rpc 接口。

...

那麼問題來了，

能不能根據代碼進行生成API文檔呢？

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

能不能適合不一樣框架的系統呢？

原理

首先用程序分析代碼的註釋，而後進行友好的展現。

實現

（1） 列出全部的API文件。
（2） 點擊文件名，能夠查看裏面的接口。
（3） 點擊接口名稱，能夠查看接口的註釋。

效果圖

PHP_DOC 實時生成 API 文檔.gif

若是你們須要下載源碼，能夠關注微信公衆號，回覆 「php_doc」 便可。

Thanks ~

---

做者：PHP後端開發者

免費提供技術諮詢服務（本身懂的知識）。

QQ羣：564557094。

關注微信公衆號，留言便可，看到留言後會及時回覆。

IT小圈兒

掘金技術徵文：gold.xitu.io/post/587f0e…