APIDOC使用避坑

在windows环境下安装nodejs，到nodejs官网下载适合自己机器的安装包之后，点击安装，一直下一步下一步，安装完成之后，打开cmd，在cmd中输入npm -v，如果有信息，那么代表nodejs安装完成，之后使用npm安装apidoc，输入npm install apidoc@0.17.6 -g，安装版本为0.17.6的apidoc，安装完成之后，需要在项目的根目录上创建一个代码的源文件夹，一个输出apidoc的文件夹，使用apidoc -i src/ -o apidoc/，其中i代表的是代码存放地址，apidoc代表的是接口文档的文件信息，这样就完成了apidoc的使用，注意，如果在安装完apidoc之后，使用apidoc -i src/ -o apidoc/这个语句出现很多警告，警告内容是关于@apiparam的参数在@api上找不到的信息，大概率是apidoc的版本问题，修改版本只需要输入上面的npm install apidoc@0.17.6 -g即可解决。