首页 技术 正文
技术 2022年11月23日
0 收藏 610 点赞 2,938 浏览 2009 个字

写在前面:

将进行3个步骤配置

1.在sublime3中安装插件docblockr,可以参考http://www.cnblogs.com/jiangxiaobo/p/8327709.html

2.安装之后在首选项中选取插件设置,找到DocBlockr插件,进行User Setting

3.配置DocBlockr,配置代码如下:

{
// 自定义配置,不建议在默认配置里进行更改,应该在User Settings里进行单独配置
"jsdocs_extra_tags" : [
// apidoc注释文档模板
"@apiIgnore 还未完成的接口,不会发布到接口文档中,删除即可此行发布",
"@api ${1:{method}} ${2:path} ${3:[title]}",
"@apiName ${1:name}",
"@apiGroup ${1:name}",
// "@apiExample {curl} 请求接口示例:",
// " curl -i 请在这儿书写接口地址",
"@apiVersion 0.0.0",
"@apiDescription 请在这儿书写接口描述,可以书写html",
"@apiUse CommonApiHeader",
"@apiHeader ${1:[(group)]} ${2:{type}} ${3:[field=defaultValue]} ${4:[description]}",
"@apiHeaderExample {json} 请求头参数示例:",
" {}",
"@apiParam ${1:[(group)]} ${2:{type}} ${3:[field=defaultValue]} ${4:[description]}",
"@apiParamExample {json} 请求参数示例:",
" {}",
"@apiSuccess ${1:[(group)]} ${2:{type}} ${3:field} ${4:[description]}",
"@apiSuccessExample {json} 成功响应数据示例:",
" HTTP/1.1 200 OK",
" {",
" \t\"code\" : 200,",
" \t\"msg\" : \"success\",",
" \t\"data\" : mixed",
" }",
"@apiUse CommonApiErrorExample",
// 作者
"@author(JiangBo)",
// 时间
"@datetime({{datetime}})"
],
"jsdocs_extra_tags_go_after" : false
}

注意:有公用的注释需要参考下

/**
* @apiDefine CommonApiErrorExample
* @apiErrorExample {json} 失败响应(Status Code=200):
* {
* "code" : 0,
* "msg" : "invalid interface"
* }
* @apiErrorExample {html} 失败响应(Status Code<>200):
* HTTP/1.1 404 Not Found
* HTTP/1.1 304 Not Modified
* HTTP/1.1 ...
*/
/**
* @apiDefine CommonApiHeader
* @apiHeader (HTTP) {string} APP_MODE 应用api模式
* @apiHeader (HTTP) {string} [CLIENT_TYPE=0] 调用者类型
* @apiHeader (HTTP) {string} [VERSION="0.0.0"] 接口版本号
* @apiHeader (HTTP) {string} [DEBUG=0] 接口测试
* @apiHeader (HTTP) {string} [SECRET] 32位接口密码(按规则生成)
* @apiHeader (HTTP) {string} [TYPE='json'] 当前请求的资源类型
* @apiHeader (HTTP) {string} [ENCRYPTED] 加密数据
* @apiHeaderExample {json} 请求头参数示例:
* {
* "APP_MODE" : "api",
* // 0-h5,1-android,2-ios
* "CLIENT_TYPE" : "1",
* // 希望请求接口版本
* "VERSION" : "0.0.0",
* // 0-正式,1-调试
* "DEBUG" : "0",
* // md5加密的请求时间戳
* "SECRET" : "282f9135c7c8ce6512c59ff1ba49eb77",
* // 希望响应的数据格式
* "TYPE" : "json",
* // 加密数据
* "ENCRYPTED" : "",
* // 请求时间戳
* "TIME_STAMP" : "1516612829"
* }
*/
/**
* @apiDefine CommonListApiParam
* @apiParam (param) {int} [pageSize=10] 一页条数
* @apiParam (param) {int} [pageNum=0] 页码
*/

微信扫一扫

支付宝扫一扫

本文网址:https://www.zhankr.net/141841.html

下一篇: requesMapping注解
相关推荐
python开发_常用的python模块及安装方法
adodb:我们领导推荐的数据库连接组件bsddb3:BerkeleyDB的连接组件Cheetah-1.0:我比较喜欢这个版本的cheeta…
日期:2022-11-24 点赞:875 阅读:5,090
Educational Codeforces Round 11 C. Hard Process 二分
C. Hard Process题目连接:http://www.codeforces.com/contest/660/problem/CDes…
日期:2022-11-24 点赞:806 阅读:3,509
下载Ubuntn 17.04 内核源代码
zengkefu@server1:/usr/src$ uname -aLinux server1 4.10.0-19-generic #21…
日期:2022-11-24 点赞:565 阅读:4,320
可用Active Desktop Calendar V7.86 注册码序列号
可用Active Desktop Calendar V7.86 注册码序列号Name: www.greendown.cn Code: &nb…
日期:2022-11-24 点赞:730 阅读:4,315
Android调用系统相机、自定义相机、处理大图片
Android调用系统相机和自定义相机实例本博文主要是介绍了android上使用相机进行拍照并显示的两种方式,并且由于涉及到要把拍到的照片显…
日期:2022-11-24 点赞:512 阅读:4,920
Struts的使用
一、Struts2的获取  Struts的官方网站为:http://struts.apache.org/  下载完Struts2的jar包,…
日期:2022-11-24 点赞:671 阅读:3,105
发表评论
暂无评论

还没有评论呢,快来抢沙发~

助力内容变现

将您的收入提升到一个新的水平

点击联系客服

在线时间:8:00-16:00

客服电话

400-888-8888

客服邮箱

ceotheme@ceo.com

扫描二维码

关注微信公众号

扫描二维码

手机访问本站