JSON文件内容加注释的几种方法「建议收藏」

JSON文件内容加注释的几种方法「建议收藏」JSON规范,不支持注释。之所以不允许加注释,主要是防止:过多的注释,影响了文件本身的数据载体的目的。有些文件,尤其是配置文件,加入解释说明一些数据项的含义,是有必要的。1、使用JSON5规范JSON5规范允许在JSON文件中加入注释:单行注释,多行注释均可。2、直接用json-schema,使用规范中的注释字段优点:功能强大缺点:json-s…

大家好,又见面了,我是你们的朋友全栈君。如果您正在找激活码,请点击查看最新教程,关注关注公众号 “全栈程序员社区” 获取激活教程,可能之前旧版本教程已经失效.最新Idea2022.1教程亲测有效,一键激活。

Jetbrains全系列IDE使用 1年只要46元 售后保障 童叟无欺

JSON规范,不支持注释。之所以不允许加注释,主要是防止:过多的注释,影响了文件本身的数据载体的目的。

有些文件,尤其是配置文件,加入解释说明一些数据项的含义,是有必要的。

1、使用JSON5规范

     JSON5规范允许在JSON文件中加入注释:单行注释,多行注释均可。

2、直接用json-schema,使用规范中的注释字段

     优点:功能强大

     缺点:json-schema与json数据本身分离

3、使用去注释的库

     可以使用npm的strip-json-comments库。

4、使用约定的key作为注释字段

     如以”//”, “_comment”,”#####”(“#”个数自定) 作为注释的key等

5、使用重名key作为注释。

     即每个key,使用两次,第1次做注释,第2次做实际属性

6、使用字段key加前缀做注释key

     常用的前缀还有”#”, “_”, “__”等。

     优点:没有重名的字段,完全符合JSON协议。

7、使用支持注释的配置文件管理模块

     如npm中rc库(见:https://github.com/dominictarr/rc),

     或者config(见:https://github.com/lorenwest/node-config)

     缺点:只能用于配置相关的Json文件。使用方法需要依照模块的要求。

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

发布者:全栈程序员-用户IM,转载请注明出处:https://javaforall.cn/183793.html原文链接:https://javaforall.cn

【正版授权,激活自己账号】: Jetbrains全家桶Ide使用,1年售后保障,每天仅需1毛

【官方授权 正版激活】: 官方授权 正版激活 支持Jetbrains家族下所有IDE 使用个人JB账号...

(0)


相关推荐

发表回复

您的电子邮箱地址不会被公开。

关注全栈程序员社区公众号