JSON 如何註釋

本身JSON是沒有類似於Java語法中的 // 或者/* */ 等語法級別的註釋語句的，所以只能變通一下。

字段註釋

• 增加一個字段，字段名爲 特殊字符(@,#,?等) + 正常字段名， 字段的內容即爲註釋內容。

• 爲了區分容易，註釋內容儘量避免使用 :,{,},[,] 等正常JSON語法一樣的標記。

  {
  	"code":1,
  	"@code":"0=正常; 1=異常"	
  }
  

描述

• 可以參照Java的大段註釋標記 /**/ 作爲字段名：

  {
  	"/**/": "這是一段描述" 
  }
  

語句註釋

• 可以參照Java的註釋標記 // 作爲字段名前綴：

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

完整描述

如果是對一個JSON文件作完整的描述，則另外寫一個和字段結構一樣的描述結構，這樣更加清晰。

• 例子

  {
  	"code": 0,
  	"message": "OK",
  	"detail": {
  		"id": "12345",
  		"name": "我的名字"
  		"createTime": "2020-05-20"
  	},
  	"@describe": {
  		"@type": "0=正常; 1=異常",
  		"@name": "姓名",
  		"@detail": {
  			"@id": "用戶ID",
  			"@createTime": "創建時間(yyyy-MM-dd)"
  		}
  	}
  }