PHP_DOC 实时生成 API 文档

更新于 2019-05-10  约 2 分钟

随着API的迅速发展,如何编写出更加规范的API文档说明则显的尤为重要。

你是否还通过手写的方式来生成和编写这些文档呢?

那么你就OUT啦!

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

本文分享一款工具:PHP_DOC

可在线实时查看API接口的参数、返回和说明,无须手动维护文档。

背景

你还在为维护 API文档 而烦恼吗?

维护 客户端 接口。

维护 Rpc 接口。

...

那么问题来了,

能不能根据代码进行生成API文档呢?

能不能生成高逼格的界面来进行展示呢?

能不能适合不同框架的系统呢?

原理

首先用程序分析代码的注释,然后进行友好的展示。

实现

(1) 列出所有的API文件。
(2) 点击文件名,可以查看里面的接口。
(3) 点击接口名称,可以查看接口的注释。

效果图

图1

图2

图3

图4

PHP_DOC 实时生成 API 文档 GIF

如果大家需要下载源码,可以关注微信公众号,回复 “php_doc” 即可。

Thanks ~


推荐阅读

clipboard.png

阅读 6.8k更新于 2019-05-10

推荐阅读
PHP 笔记
用户专栏

技术的深度和广度只能靠自己努力去发掘,谁也不能替你学习,在这里希望你能有所收获。

119 人关注
57 篇文章
专栏主页
目录