【文件属性】:
文件名称:php-apidoc:带有示例API的APIDoc演示存储库,并通过Grunt自动构建
文件大小:208KB
文件格式:ZIP
更新时间:2021-05-18 14:55:23
PHP
API文档生成器
概述
此项目设置旨在自动执行API文档。
结合使用...
特定于APIPHPDoc注释
Node任务运行器
NPM模块
... HTML文档将在注释和保存时从源PHP文件自动生成。
可以在浏览器中查看生成的文档:
对受监视源文件的任何更改将自动重建文档并重新加载浏览器。
生成的文档的示例可以在。
安装
确保在系统上安装了Node,并确保全局安装了以下软件包
咕CLI的CLI
npm install grunt-cli -g
API文档
npm install apidoc -g
然后通过从docs文件夹中的命令行运行以下命令来安装项目的模块:
npm install
配置和构建
配置
要配置要监视的文件,请打开Gruntfile.js并在文件的开头编辑变量。
当前,正在监视api/routes的更改。
开始构建过程
在项目的根文件夹中运行以下命令
【文件预览】:
php-apidoc-master
----.gitignore(51B)
----docs()
--------apidoc.json(201B)
--------Gruntfile.js(2KB)
--------package.json(755B)
--------readme.md(2KB)
--------template()
----LICENSE(1KB)
----api()
--------routes()
--------utils()
--------index.php(433B)
--------composer.lock(4KB)
--------composer.json(186B)
--------models()
--------controllers()