1、 安装node.js 和npm
-
前往 https://nodejs.org/en/ 下载node.js的最新版本,双击.pkg进行安装
-
在终端输入
node -v
,如正确输出版本号即安装成功(由于node.js集成了npm环境,因此无须再次安装npm)
-
在终端输入
npm -v
,输出npm版本号
2、安装apidoc(官网https://apidocjs.com/)
-
在终端输入
npm install apidoc -g
-
apidoc -h 检测apidoc是否安装成功
-
在项目根目录需要加apidoc.json配置文件(官网有更多参数配置)
-
在终端输入
apidoc -i 指定项目需生成文档的文件路径/ -o 生成文档输出路径/(输出路径可以是任意路径,执行成功后直接双击打开指定生成路径下的index.html,文档便呈现在眼前了)
-
至于文档格式可以参考官网,每次都需要执行生成命令哟