一、环境准备
1.安装node.js,官网:https://nodejs.org/en/点击打开链接;windows64位下载地址https://nodejs.org/dist/v8.9.4/node-v8.9.4-x64.msi下载;
2.安装apidoc,命令行下,输入npm install apidoc -g,参考官网:http://apidocjs.com/#install 点击打开链接
npminstallapidoc -g
安装完毕,可在命令下使用apidoc -h测试是否安装成功
apidoc -h
3.apidoc指令能成功识别,apidoc环境便已经安装好了,这时可在项目中使用,所有的代码基于注释即可。
二:在项目中使用
1.项目根路径下建立apidoc.json文件,配置好基本的文档信息。