JSON常用的几种注释代码示例

更新时间：2024年08月17日 11:19:32 作者：viceen

JSON是一种轻量级的数据交换格式,下面这篇文章主要给大家介绍了关于JSON常用的几种注释,文中通过代码介绍的非常详细,需要的朋友可以参考下

JSON的几种注释

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

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

json里面有自己约定俗成的注释规范。

1、在json文件中，采用"//"，其value就是添加的注释内容。

{
    "//": "注释语句最小值",
    "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)"
	}
}

总结

到此这篇关于JSON常用的几种注释的文章就介绍到这了,更多相关JSON的几种注释内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

json
注释

Hadoop环境搭建过程中遇到的问题及解决方法
这篇文章主要介绍了Hadoop环境搭建过程中遇到的问题及解决方法，本文给大家介绍的非常详细，具有一定的参考借鉴价值，需要的朋友参考下吧
2019-08-08
Typora自动编号的具体操作
相比较world这种文档编辑器而言，Typora更适合写一些程序相关的博客，因为可以用代码+快捷键的方式，方便的对文章内容进行处理，不用在担心排版和样式变形的问题了，在编辑的过程中，就能预览到效果
2021-12-12
ollama搭建本地ai大模型并应用调用的操作方法
这篇文章详细介绍了如何下载、安装和使用OLLAMA大模型,包括启动配置模型、配置UI界面、搭建本地知识库、配置文件开发、环境变量配置以及通过Golang实现接口调用的示例
2024-11-11
DataGrip 2020.1 安装与激活方法
DataGrip是一款数据库管理客户端工具，方便连接到数据库服务器，执行sql、创建表、创建索引以及导出数据等。这篇文章主要介绍了DataGrip 2020.1 安装与激活教程,需要的朋友可以参考下
2020-09-09
Elasticsearch索引的分片分配Recovery使用讲解
这篇文章主要为大家介绍了Elasticsearch索引的分片分配Recovery使用讲解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-04-04
程序员面试如何提高面试通过率
这篇文章主要给大家介绍了关于程序员面试如何提高面试通过率的相关资料,通过文中介绍的方法可以提高面试概率,让大家尽快找到好工作,需要的朋友可以参考下
2007-04-04
使用Git向GitHub上传更新内容
这篇文章介绍了使用Git向GitHub上传更新内容的方法，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2022-04-04
RabbitMQ队列中间件消息持久化确认机制死信队列原理
这篇文章主要介绍了消息队列中间件之RabbitMQ消息的持久化、确认机制、死信队列原理详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-05-05
MacOS上Homebrew 安装、配置、更改国内镜像源及使用图文详解
Homebrew是一个强大的包管理器,适用于macOS和Linux系统,可以简化软件的安装、升级和卸载过程,它包括brew、homebrew-core、homebrew-cask和homebrew-bottles四个主要部分,通过tap和cask可以扩展功能,安装图形界面应用,Homebrew还提供了各种命令来管理和维护已安装的软件包
2024-11-11
解决appcode打开workspace无法找到xcodeproj项目文件问题
这篇文章主要介绍了解决appcode打开workspace无法找到xcodeproj项目文件问题,本文通过图文并茂的形式给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-02-02