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

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

时间： 2024-08-28 05:33:41

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

shell------打印出文档中只含有一个数字的行

写一个shell脚本,要求打印出文档中只含有一个数字的行: #!/bin/bash for i in `cat /root/passwd` ;do n=`echo $i |sed 's/[^0-9]//g'|wc -c` #echo $n if [ $n -eq 2 ];then echo $i else continue fi done 执行以下此脚本

Android官方入门文档[4]启动另一个Activity Starting Another Activity启动另一个Activity This lesson teaches you to1.Respond to the Send Button2.Build an Intent 3.Create the Second Activity4.Receive the Intent5.Display the Message You should also read?Installing the SDK

Android官方入门文档[15]重新创建一个Activity活动

Android官方入门文档[15]重新创建一个Activity活动 Recreating an Activity重新创建一个Activity活动 This lesson teaches you to1.Save Your Activity State2.Restore Your Activity State You should also read?Supporting Different Screens?Handling Runtime Changes?Activities 这节课教你1.保存

ApiDoc 文档使用方式

1.安装node.js 2.打开node.js 命令窗(shell)键入npm install apidoc -g 自动安装(几分钟) 3. C:\Users\user\AppData\Roaming\npm\node_modules\apidoc\example 目录下的example.js是文档的模板,用来生成我们需要的文档在C:\Users\user\AppData\Roaming\npm\node_modules\apidoc下新建一个文件夹doc(自定义即可),作为文档输出目录 Ps

将一个项目中已有的文档添加到另一个项目中的方法

我本来是在第一个项目中打开Finder,然后直接拖拽到第二个项目中的. 但发现删除第一个项目,第二个项目中直接找不到那几个拖拽过去的文档了. 所以对于我的情况,也就是从网上搞来的代码,需要打开Finder,从第一个项目的文件夹中,将需要的文件(或文件夹)拷入第二个项目的文件夹中. 然后在第二个项目的Xcode界面中点击File -> Add Files to ... -------------------------------------------------------- Xcode这种设

我的PHP爬虫实现一页式学习工具 : 我的超级文档查看利器把文档所有页面当做一个页面输出一直pagedown就可以快速学习关键词完整全文搜索

http://localhost/startstep/web/index.php?r=bianchen/wendang&wengdang=scrapyd&shuchuyeshu=999 原文地址:https://www.cnblogs.com/stillstep/p/11100185.html

使用 Swagger 自动生成 ASP.NET Core Web API 的文档、在线帮助测试文档（ASP.NET Core Web API 自动生成文档）

对于开发人员来说,构建一个消费应用程序时去了解各种各样的 API 是一个巨大的挑战.在你的 Web API 项目中使用 Swagger 的 .NET Core 封装 Swashbuckle 可以帮助你创建良好的文档和帮助页面. Swashbuckle 可以通过修改 Startup.cs 作为一组 NuGet 包方便的加入项目.Swashbuckle 是一个开源项目,为使用 ASP.NET Core MVC 构建的 Web APIs 生成 Swagger 文档.Swagger 是一个机器可读的 R

docfx 做一个和微软一样的文档平台

https://blog.csdn.net/lindexi_gd/article/details/78661304 c#(166) 版权声明:http://blog.csdn.net/lindexi_gd 本文为博主原创文章,未经博主允许不得转载. https://blog.csdn.net/lindexi_gd/article/details/78661304 目录(?)[+] 开发中,有一句话叫最不喜欢的是写文档,最不喜欢的是看别人家代码没有文档.那么世界上文档写最 la 好 ji 的就

多人协作时编辑word文档的一个小窍门

多人协作时编辑word文档的一个小窍门最近在工作中编写标书时由于不同内容分给了各个部门去制作,但是在汇总后遇到再次修改的问题.对方把修改后的部分文档发给我粘贴到标书中后,所有的格式全部都乱了.重新整理格式.标题,每次导入新的文档都重复这个工作,真是低效啊.事后想想word这么高级的文档编辑工具,肯定会有解决办法吧? 解决办法一文档合并将每个章节划分为多个文档,文档名称命名为章节编号,然后: 我们需要新建一个word文档并对这个文档的页面进行设置,使之与要合并的其他文档的页面设置保持一致,或