JSON中如何注释呢?

麦迪 Java经验 发布时间:2023-12-17 22:10:01 阅读数:10192 1
下文笔者讲述JSON中写入注释的方法分享,如下所示
JSON编写注释的方法分享  
   字段注释:
      增加一个字段
      字段名为 特殊字符(@,#,?等) + 正常字段名, 字段的内容即为注释内容。
 
 语句注释:
      可以参照Java的注释标记 // 作为字段名前缀:
  
完整描述
      如果是对一个JSON文件作完整的描述
       则另外写一个和字段结构一样的描述结构,这样更加清晰   
例:

字段注释

  增加一个字段
     字段名为 特殊字符(@,#,?等) + 正常字段名
     字段的内容即为注释内容 
为了区分容易
    注释内容尽量避免使用 :,{,},[,] 
    等正常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)"
	}
}
版权声明

本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。

本文链接: https://www.Java265.com/JavaJingYan/202312/17028222397478.html

最近发表

热门文章

好文推荐

Java265.com

https://www.java265.com

站长统计|粤ICP备14097017号-3

Powered By Java265.com信息维护小组

使用手机扫描二维码

关注我们看更多资讯

java爱好者