JSON文件内容加注释的几种方法

转载：https://blog.csdn.net/ShiMengRan107/article/details/101761922

 

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文件。使用方法需要依照模块的要求。