1. 程式人生 > >關於apidoc文檔生成不了的一個原因

關於apidoc文檔生成不了的一個原因

文檔 msg font get ont 找不到 原創 app resp

前幾天在寫完API後,寫註釋文檔,然後很習慣的去用apidoc取生成註釋文檔,但是奇怪的事發生了,沒有註釋的內容,也沒有報錯;註釋代碼如下:

/*
* @api {get} /applet/:id 根據編號,獲取場地id
* @apiGroup applet
* @apiVersion 2.2.0
* @apiParam {integer} id 二維碼編號
* @apiSuccessExample {json} Success-Response:
* {
"code": 1,
"msg": "成功",
"result": {
"field_id": 101
},
"total": 0
}
* @apiSuccess (code狀態碼表) {Number} -603 此二維碼還未綁定場地!
*
*/

看了半天註釋,沒錯啊,對吧,自己找了半天的錯誤也找不到是原因,後來仔細對比了別的API的註釋,找到了一個不怎麽確定因素,“第一行註釋少寫了一個*號
”,這個難道是問題的所在?不可能吧,自己都不太相信,半信半疑的加了*,然後生成了一下,我擦,居然有文檔了。就這麽神奇的解決了。
本文屬於個人原創!
歡迎轉載,轉載請附連接: http://www.cnblogs.com/x-x-j/p/7233662.html

關於apidoc文檔生成不了的一個原因