关于json中的注释
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
[
"## 对于MailType，后期统一换成int类型，现在先强制写成字符串 [ReqMailType 后期也需要调整为in值]",
"## @开头的key值，表示对该key值的解释",
"## 当前块内‘## ’开头的表示这一行是注释",
"## 格式为‘********XXXX********’的，表示是一大的类别",
"************************常见基础格式*************************",
"## 基础邮件格式 [每一封邮件都至少包含这些信息]",
{
"FromMID": 10,
"ToMID": 11,
"MailType": "SGIS_Mail",
"@FromMID": "来源的邮箱ID",
"@ToMID": "目的地的邮箱ID",
"@MailType": "邮件类型"
}
]
通过上述方式，对于常规的json格式的接口进行注释。但是json数据格式自身没有统一的注释写法，这里只是因为key略微不同，json数据不会报错才这样写的，也可以使用其他的方式，比如前缀或后缀下划线之类的，也能达到同样的效果。
个人觉得只要是自己能够看懂就行，如果其他人需要使用这份数据，那就让他自己学习吧。
