json文件怎么写注释?json文件加注释的方法

阳光 2021-02-03 18:19:54 java常见问答 5888

根据JSON规范是不支持注释的。之所以不允许加注释,主要就是怕影响了文件本身的数据载体。但是有些文件,尤其是配置文件,加入解释说明一些数据项的含义,是有必要的。那么json文件怎么写注释?今天我们就来给大家讲解一下这方面的内容。

方法一:直接用json-schema,使用规范中的注释字段

在json-schema规范中数据结构定义JSON中有一些说明性字段(Annotation),这些字段对应的key有title, description, $comment, default, examples等,可以在这些字段(一般1个即可)中填写某个数据项的含义与用法。这个方案的优点是功能强大,缺点是json-schema与json数据本身还是分离的。

方法二:使用JSON5规范

JSON5规范允许在JSON文件中加入注释:单行注释,多行注释均可,可以使用npm的json5库,用法与JSON库类似。

方法三:使用去注释的库

可以使用npm的strip-json-comments库。支持去掉行注释与块注释,然后再可以用标准的JSON。

方法四:使用约定俗成的key作为注释字段

如以"//"作为注释的key. 但是如果有多个以"//"为key的属性,是否符合协议的?答案是:协议理论上不允许。实现上(几乎?)所有的JS环境都允许,解析之后,只保留最后一项常用的类似key还有: "_comment", "#####"("#"个数自定)等。

方法五:使用重名key作为注释。

即每个key,使用两次,第1次做注释,第2次做实际属性。原理在方法四中已经介绍:协议理论上不允许。实现上(几乎?)所有的JS环境都允许,解析之后,只保留最后一项。

方法六:使用字段key加前缀做注释key

例如加入属性的key是xyz, 则?xyz作为注释字段。这样的好处是,没有重名的字段,完全符合JSON协议。常用的前缀还有"#", "_", "__"等。

方法七:使用支持注释的配置文件管理模块

如npm中rc库,缺点是,只能用于配置相关的Json文件。使用方法需要依照模块的要求。

这7中方法都是json文件加注释的实用渠道,如果大家在使用配置文件的时候,可以利用以上这些方法去加注释,这样更加有利于java人员开发哦!最后大家如果想要了解更多json工具教程知识,敬请关注奇Q工具网。

推荐阅读:

json文件如何转换成excel?json有局限性吗?

java多线程有哪些面试题?多线程面试题及答案

java运行不出来怎么回事?Java如何成功运行?