关于json文件想要添加注释怎么处理

json格式本身不支持注释,json的本意就是极简的通用数据传输。加了备注就不是极简了。

1.注释用来说明这个key做什么用

2.希望添加注释之后,不会影响原本的交互逻辑。

比较好的方法是:json文件里面额外增加一个key "key_comment"用来描述这个key的作用。

但是如果本来json文件只是一个例子而不是实际被使用的配置文件,那么可以使用json5,IDEA之类的开发软件也支持配置(简单来说就是不报红,没有错误警告)。

推荐key_comment,因为json5实际上并不是真正的json文件,如果你忘记你使用的是json5的编辑器把他当作真正的json,那么有些错误不容易被发现。

posted on 2023-04-28 17:12  我欲皆真  阅读(1507)  评论(0编辑  收藏  举报

导航