JSON的几种注释

大家好，欢迎来到IT知识分享网。

JSON的几种注释

本身JSON是没有类似于Java语法中的 // 或者/* */ 等语法级别的注释语句的

在json文件中用传统的注释格式（// //）进行注释，是不符合json规范的。

{ 
    "//": "注释语句最小值", "min": "58", } 

2、在需要注释的字段前面添加?， 当然#和_也是可以的。

{ 
    "?min": "注释语句最小值", "min": "58", } 

字段注释

• 增加一个字段，字段名为 特殊字符(@,#,?等) + 正常字段名， 字段的内容即为注释内容。
• 为了区分容易，注释内容尽量避免使用 :,{
,},[,] 等正常JSON语法一样的标记。

{ 
    "code":1, "@code":"0=男; 1=女" } 

描述

• 可以参照Java的大段注释标记 // 作为字段名

{ 
    "//": "这是一段描述" } 

语句注释

• 可以参照Java的注释标记 // 作为字段名前缀：

{ 
    "name": "我的名字", "//name": "你的名字" } 

完整描述

如果是对一个JSON文件作完整的描述，则另外写一个和字段结构一样的描述结构，这样更加清晰。

• 例子

{ 
    "code": 0, "message": "OK", "data": { 
    "id": "12345", "type": 0, "name": "我的名字" "createTime": "2020-05-20" }, "#data": { 
    "#id": "用户ID", "#type": "0=男; 1=女", "#name": "姓名", "#createTime": "创建时间(yyyy-MM-dd)" } }