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

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

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

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

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

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

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

posted on   我欲皆真  阅读(1958)  评论(0编辑  收藏  举报

相关博文:
阅读排行:
· 被坑几百块钱后,我竟然真的恢复了删除的微信聊天记录!
· 没有Manus邀请码?试试免邀请码的MGX或者开源的OpenManus吧
· 【自荐】一款简洁、开源的在线白板工具 Drawnix
· 园子的第一款AI主题卫衣上架——"HELLO! HOW CAN I ASSIST YOU TODAY
· Docker 太简单,K8s 太复杂?w7panel 让容器管理更轻松!
历史上的今天:
2020-04-28 为什么方法重载是编译时多态,为什么方法重写和向上转型是运行时多态

导航

< 2025年3月 >
23 24 25 26 27 28 1
2 3 4 5 6 7 8
9 10 11 12 13 14 15
16 17 18 19 20 21 22
23 24 25 26 27 28 29
30 31 1 2 3 4 5
点击右上角即可分享
微信分享提示