PHP_DOC 實時生成 API 文檔

時間 2019-11-09

標籤 php doc 實時生成 api 文檔欄目 PHP 简体版

原文原文鏈接

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

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

那麼你就OUT啦！緩存

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

本文分享一款工具：PHP_DOC。微信

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

背景

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

維護客戶端接口。spa

維護 Rpc 接口。code

...接口

那麼問題來了，

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

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

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

原理

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

實現

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

效果圖

圖1

圖2

圖3

圖4

PHP_DOC 實時生成 API 文檔 GIF

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

Thanks ~

推薦閱讀

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。