php json注释,【部分解决】Json中添加注释

【问题】

通过json文件给python脚本传递参数，但是希望每个参数都有对应的注释，以方便使用者知道该参数的确切含义。

问题转化为给json中添加注释。

【解决过程】

1.网上找了json的官网JSON,没看到关于添加注释的说明。

就像某人说的，json的出现，本身就是为了压缩，减少数据量，所以理论上就不支持注释，也是可以理解的。

去尝试：{

…

}

// outside of json comment test –> no work

// begin of json comment test –> no work

{

…

}

的结果，也还是无效。

其他的，也试过了：

/* comments here */

都不行。

得到一个妥协的办法，那就是，把需要添加的注释，当成json中的某个key和value，就像普通的数据一样，比如那位给出的例子：{

"_comment" : "comment text goes here...",

"glossary": {

"title": "example glossary",

"GlossDiv": {

"title": "S",

"GlossList": {

"GlossEntry": {

"ID": "SGML",

"SortAs": "SGML",

"GlossTerm": "Standard Generalized Markup Language",

"Acronym": "SGML",

"Abbrev": "ISO 8879:1986",

"GlossDef": {

"para": "A meta-markup language, used to create markup languages such as DocBook.",

"GlossSeeAlso": ["GML", "XML"]

"GlossSee": "markup"

}

目前看来，除此之外，也没啥其他的好办法了。

4.另外，也看到这里：

在讨论，给json组织建议，添加对应的spec规范说明，希望支持：

json的decoder编码出来的数据，不包含对应的comment，但是encoder应该支持comments

然后希望对应的comments的格式是

// single line comment

/* multi line comments */

之类的。

然后在传输数据过程中，则不需要传输这些comments。

等等讨论和建议。个人觉得还是蛮合理的，只是此刻，我用的python 2.7中的json，还是不支持decode带comments的json啊。。。。

【总结】

目前我这里的Python 2.7中的json，不支持类似于//xxx和/* xxx*/的注释，暂时的妥协办法只能是，把需要添加的注释，当做数据，写入到json里面。虽然效率很低，但是也只能这样了。

希望以后json的encoder和decoder支持对应的带comments的编解码。

php json注释,【部分解决】Json中添加注释相关推荐

[译] 代码中添加注释之好坏丑
原文地址:Putting comments in code: the good, the bad, and the ugly. 原文作者:Bill Sourour 译文出自:掘金翻译计划译者: ba ...
《正则表达式经典实例（第2版）》——2.18　向正则表达式中添加注释
本节书摘来自异步社区<正则表达式经典实例(第2版)>一书中的第2章,第2.18节,作者: [美]Jan Goyvaerts , Steven Levithan著,更多章节内容可以访问云栖社 ...
Matlab：向图中添加注释
Matlab:向图中添加注释创建简单的图圆圈注释文本箭头注释注释是添加到图中的额外信息,用来帮助标识一些重要信息.此示例首先解释不同类型的注释,然后说明如何向图中添加圆圈和文本箭头. #注释的 ...
java注释里加_如何在代码中添加注释
什么是代码注释,如何在代码中添加注释,相信每一位了解编程的人并不陌生.注释里往往有很多有趣的脑洞和「真心话」.今天我们一起去看看那些6到飞起,被玩坏了的幽默注释吧. 信息量太大的注释系列-- 1.你造 ...
用endnote在word中添加注释
1.安装endnote 2.打上中文破解版补丁 3.由于之前加载项的残留,管理员模式启动word删除原来的加载项 4.安装新的word加载项至此,安装完毕在endnote中添加文章: 1.新建en ...
Eclipse 中添加注释，注释中包含作者时间等
Eclipse 中添加注释,注释中包含作者时间等在使用Eclipse工作是,为了防止有人程序报错甩锅给自己,我们一般都会在Eclipse中添加注释,注释内容一般包括:作者.时间.类别.版本号等,来鉴 ...
matlab 集体注释,向程序中添加注释 - MATLAB Simulink - MathWorks 中国
向程序中添加注释编写代码时,最好添加描述代码的注释.注释有助于其他人员理解您的代码,并且有助您在稍后返回代码时再度记起.在程序开发和测试期间,您还可以使用注释来注释掉任何不需要运行的代码. 在实时编 ...
MATLAB中添加注释
MATLAB中添加注释的方法: 1. 选中想要注释的代码,然后加入"%"符号,可以看到,代码的颜色从黑色变成了绿色即为注释成功: 2.可以使用快捷键:Ctrl+R给选中的代码添加注 ...
注释向 Java 代码中添加元数据
注释,J2SE 5.0 (Tiger) 中的新功能,将非常需要的元数据工具引入核心 Java 语言.该系列文章分为两部分,在这第 1 部分中,作者 Brett McLaughlin 解释了元数据如此有 ...

php json注释,【部分解决】Json中添加注释

php json注释,【部分解决】Json中添加注释相关推荐

最新文章

热门文章