經過apidoc生成api文檔

參考：

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