参考:
http://apidocjs.com/
http://blog.csdn.net/xumin198908/article/details/41964159
1)环境准备(前提是已经具备nodejs环境)
npm install apidoc -g
2)添加注释
/**
* @api {get} / 请求APP信息
* @apiName 请求APP信息
* @apiGroup User
*
*
*
* @apiSuccess {String} return_code Firstname of the User.
* @apiSuccess {String} return_msg Lastname of the User.
* @apiSuccess {String} err_code Lastname of the User.
* @apiSuccess {String} err_msg Lastname of the User.
* @apiSuccess {Object[]} appInfo Lastname of the User.
*/
3)生效生成
apidoc -i myapp/ -o apidoc -e "node_modules"
注意
i,代表输入,即要生成文档的项目
o,代表输出,文档的目的地
e,代表排除,排除某些文件或文件夹
3)查看
/apidoc/index.html