JSON 如何注释

本身JSON是没有类似于Java语法中的 // 或者/* */ 等语法级别的注释语句的，所以只能变通一下。

字段注释

• 增加一个字段，字段名为 特殊字符(@,#,?等) + 正常字段名， 字段的内容即为注释内容。

• 为了区分容易，注释内容尽量避免使用 :,{,},[,] 等正常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)"
  	}
  }