使用apidoc生成项目文档

【1】npm install apidoc -g 全局安装apidoc

【2】apidoc -v 查看是否安装成功

【3】apidoc.json apidoc的项目级配置文件,它必须位于整个工程目录顶层

【4】demo.java 用于演示的demo源文件,它可以位于整个工程目录的顶层目录及其子目录下,apidoc会搜索整个工程目录选择所有可能的源文件

【5】apidoc -i src/ -o apidoc/ 如果Done结果,则表明文档已经生成,位于同级目录的apidoc(与-o apidoc对应)目录下

【注】apidoc -i myapp/ 选择源代码所在的位置

【注】apidoc -o apidoc/ 选择生成文件所在的位置

——————————————————————————————————————————————————————————————————

 

【1】npm install apidoc -g 全局安装apidoc
【2】在项目下创建apidoc.json文件
【3】准备好示例文件(包含接口注释的文件)
【4】cd到项目根目录下,运行命令apidoc即可生成接口文档

 

posted @ 2019-03-27 09:53  _0123456789  阅读(384)  评论(0编辑  收藏  举报