我们知道，添加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.parse解析strip-json-comments。
方法四：使用约定俗成的key作为注释字段
如以"//"作为注释的key. 但是如果有多个以"//"为key的属性，是否符合协议的?答案是：协议理论上不允许。实现上(几乎?)所有的JS环境都允许，解析之后，只保留最后一项常用的类似key还有： "_comment", "#####"("#"个数自定)等。
方法五：使用重名key作为注释
即每个key，使用两次，第1次做注释，第2次做实际属性。原理在方法四中已经介绍：协议理论上不允许。实现上(几乎?)所有的JS环境都允许，解析之后，只保留最后一项。
方法六：使用字段key加前缀做注释key
例如加入属性的key是xyz, 则?xyz作为注释字段。这样的好处是，没有重名的字段，完全符合JSON协议。常用的前缀还有"#", "_", "__"等。
这些就是json文件添加注释的方法，总共有六种方法，大家可以根据自己的要求去选择注释方法，让程序变得更加有意义!最后大家如果想要了解更多json工具教程知识，敬请关注奇Q工具网。
推荐阅读：