文档生成工具 APIDOC 笔记

文档生成工具 APIDOC 笔记

简介

代码即文档，代码注释生成文档是一种很好的文档方式。通过文档的时序化更新可以追溯整个工程的历史进程。团队的延续也需要良好的文档支持。我们团队使用的是APIDOC这种工具，该工具十分方便，上手快支持的语言多。

建议直接在文档所在目录进行命令行操作。

入门

1、安装命令

npm install apidoc -g

2、运行命令

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

apidoc 即工具 -i 即 输入文件路径 -o 输出文件路径 -t 我的模板
在没有任何参数的情况下，apiDoc 会提取出所有的 .cs .dart .erl .go .java .js .php .py .rb .ts格式的文件，并将其输出结果输出到 * ./doc/*中。

命令参数

1、帮助命令

apidoc -h

2、-f, –file-filters

使用这则表达式来选择文件进行处理。默认包括.cs .dart .erl .go .java .js .php .py .rb .ts。

代码示例：
下面代码只负责解析js和ts文件

    apidoc