关于apidoc文档生成不了的一个原因

Posted 2020-09-29 寞小陌

前几天在写完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