php apidoc 注释,ApiDoc 后端接口注释文档的使用

前端和后端注释文档生成

前端和后端的 函数及api 说明文档生成总结，持续更新中 by Qzx

参考网址

apiDoc的使用教程

一、安装

# 全局安装

npm install apidoc -g

# 查看是否安装成功,显示命令行参数

apidoc -h

二、apidoc 常用命令说明

指令简写

指令全称

说明

-f

--file-filters

过滤器，指定应该解析的文件类型，后缀 (可以使用多个-f)。默认.cs .dart .erl .go .java .js .php .py .rb .ts。示例(仅解析.js和.ts文件)：apidoc -f ".*\.js" -f ".*\\.ts"

-e

--exclude-filters

过滤器用于选择不应该解析的文件

-i

--input

指定输入的源目录名，项目文件的位置，默认为 ./ 例：apidoc -i myapp/

-o

--output

指定输出的目录文件名，放置生成文档的位置，默认为 ./doc/，例：apidoc -o apidoc/

-t

--template

指定要用的外部模板的路径，可以创建和使用自己的模板，默认使用全局的 node_modules/apidoc/template/ ，例：apidoc -t mytemplate/

-c

--config

指定配置文件的路径 apidoc.json ./

-h

--help

显示详细的帮助说明

--debug

--debug

显示调试的信息，默认为 false

三、具体使用

在项目文件夹新建apidoc.json;

在项目目录运行：

apidoc -i myapp/ -o apidoc/ -t mytemplate/

# 简写指令

apidoc

说明：上面的指令可以直接简写为 apidoc，没有任何参数时，默认从当前目录(包括子目录)下格式为(.cs .dart .erl .go .java .js .php .py .rb .ts) 的所有文件生成文档并将输出写入 ./doc/。

四、基本配置(apidoc.json)

项目根目录下的 apidoc.json 可配置项包含有关项目的常用信息，如 标题，简短描述、版本和配置选项，如页眉/页脚设置或模板特定选项。

基本配置方式(apidoc.json)

{

"name": "example",

"version": "0.1.0",

"description": "apiDoc basic example",

"