可以在JSON中使用注释吗？

如果您的文本文件(即JSON字符串)将被某些程序读取,那么在使用之前删除C或C++样式注释有多难？

答:这将是一个班轮.如果您这样做,那么JSON文件可以用作配置文件.

如果您使用带有ASP.NET的Newtonsoft.Json库来读取/反序列化,则可以使用JSON内容中的注释:

//"name":"string"

//"id":int

要么

/*这是一个

评论示例*/

PS:只有6个以上版本的Newtonsoft Json支持单行注释.

对于那些无法开箱即用的人的补充说明:我在我制作的ASP.NET Web应用程序中使用JSON格式进行基本设置.我读取文件,使用Newtonsoft库将其转换为设置对象,并在必要时使用它.

我更喜欢在JSON文件本身中编写关于每个单独设置的注释,并且我真的不关心JSON格式的完整性,只要我使用的库可以正常使用它.

我认为这是一种"更易于使用/理解"的方式,而不是创建单独的"settings.README"文件并解释其中的设置.

如果您对此类用法有疑问; 对不起,精灵已经没了灯.人们会发现JSON格式的其他用法,你无能为力.

JSON背后的想法是在应用程序之间提供简单的数据交换.这些通常是基于Web的,语言是JavaScript.

它实际上并不允许这样的注释,但是,将注释作为数据中的一个名称/值对传递肯定会起作用,尽管这些数据显然需要被解析代码忽略或处理.

总而言之,JSON文件不应该包含传统意义上的注释.它应该只是数据.

有关更多详细信息,请查看JSON网站.

我刚刚遇到配置文件.我不想使用XML(冗长,图形,丑陋,难以阅读)或"ini"格式(没有层次结构,没有真正的标准等)或Java"属性"格式(如.ini).

JSON可以做他们能做的所有事情,但它更简洁,更人性化 - 解析器在许多语言中都很容易和无处不在.它只是一个数据树.但是,带外注释通常是记录"默认"配置等的必要条件.配置永远不会是"完整文档",而是保存数据的树,在需要时可以是人类可读的.

我想可以使用"#": "comment""有效"JSON.

这取决于您的JSON库.Json.NET支持JavaScript风格的评论/* commment */.

请参阅另一个Stack Overflow问题.

JSON本身不支持注释,但您可以创建自己的解码器或至少预处理器来删除注释,这非常好(只要您忽略注释并且不使用它们来指导应用程序应如何处理JSON数据).

JSON没有评论.JSON编码器绝不能输出注释.JSON解码器可以接受和忽略注释.

绝不应该使用注释来传输任何有意义的内容.这就是JSON的用途.

Cf:Douglas Crockford,JSON规范的作者.

JSON用于支持评论,但它们被滥用并从标准中删除.

来自JSON的创建者:

我从JSON中删除了注释,因为我看到有人使用它们来保存解析指令,这种做法会破坏互操作性.我知道缺乏评论会让一些人感到悲伤,但事实并非如此.- 道格拉斯·克罗克福德,2012年

官方JSON站点位于JSON.org.JSON被ECMA International 定义为标准.总是有一个请愿程序来修改标准.由于多种原因,注释不太可能添加到JSON标准中.

JSON设计是一种易于反向设计(人工解析)的XML替代方案.甚至简化到注释是不必要的.它甚至不是标记语言.目标是稳定性和互操作性.

任何了解面向对象"has-a"关系的人都可以理解任何JSON结构 - 这就是重点.它只是一个带有节点标签(键/值对)的有向无环图(DAG),它是一种近乎通用的数据结构.

这个唯一的注释可能是"//这些是DAG标签".密钥名称可以根据需要提供信息.

任何平台都可以用几行代码解析JSON.XML需要复杂的OO库,这些库在许多平台上都不可行.

注释只会使JSON的互操作性降低.除非您真正需要的是标记语言(XML),否则无需添加任何其他内容,并且不关心是否可以轻松解析持久化数据.

JSON对配置文件和其他本地用法很有意义,因为它无处不在,因为它比XML简单得多.

如果人们有充分的理由反对在传递数据时使用JSON进行评论(无论是否有效),那么可能JSON可以分为两部分:

JSON-COM:线上的JSON,或者在传递JSON数据时应用的规则.

JSON-DOC:JSON文档,或文件或本地JSON.定义有效JSON文档的规则.

JSON-DOC将允许注释,并且可能存在其他微小差异,例如处理空白.解析器可以轻松地从一个规范转换为另一个规范.

至于该言论道格拉斯克罗克福德在这个问题上取得了(由@Artur Czajka参考)

假设您使用JSON来保留要注释的配置文件.继续,插入您喜欢的所有评论.然后通过JSMin将其传递给JSON解析器.

我们正在讨论通用配置文件问题(跨语言/平台),他正在回答JS特定的实用程序!

当然,JSON特定的minify可以用任何语言实现,但是标准化,因此它在所有语言和平台的解析器中变得无处不在,所以人们不再浪费他们的时间缺乏这个功能,因为他们有很好的用例,看看问题在在线论坛,并让人们告诉他们这是一个坏主意或建议很容易实现从文本文件剥离评论.

另一个问题是互操作性.假设您有一个库或API或任何类型的子系统,其中包含一些与之关联的配置或数据文件.这个子系统可以从不同的语言访问.然后你去告诉别人:顺便说一下,在将它们传递给解析器之前不要忘记从JSON文件中删除注释!

Dojo Toolkit JavaScript工具包(至少从版本1.4开始)允许您在JSON中包含注释.评论可以是/* */格式.Dojo Toolkit通过dojo.xhrGet()调用消耗JSON .

其他JavaScript工具包可能类似地工作.

在选择最终选项之前尝试使用备用数据结构(甚至数据列表)时,这会很有用.

如果您使用JSON5,则可以包含注释.

JSON5是JSON的建议扩展,旨在使人们更容易手动编写和维护.它通过直接从ECMAScript 5添加一些最小语法功能来实现这一点.

JSON不是框架协议.它是一种无语言格式.因此,没有为JSON定义注释的格式.

正如许多人所建议的,有一些技巧,例如,重复键或_comment您可以使用的特定键.由你决定.

您可以在JSONP中发表评论,但不能在纯JSON中发表评论.我花了一个小时试图让我的程序与Highcharts中的这个例子一起工作:http://www.highcharts.com/samples/data/jsonp.php ？ filename = aapl-c.json&callback =？

如果您点击链接,您会看到

?(/* AAPL historical OHLC data from the Google Finance API */
[
/* May 2006 */
[1147651200000,67.79],
[1147737600000,64.98],
...
[1368057600000,456.77],
[1368144000000,452.97]
]);

由于我在本地文件夹中有一个类似的文件,因此同源策略没有问题,因此我决定使用纯JSON ......当然,$.getJSON由于注释而无法静默失败.

最后我只是向上面的地址发送了一个手动HTTP请求,并意识到内容类型是text/javascript,因此,JSONP返回纯JavaScript.在这种情况下,允许评论.但我的应用程序返回内容类型application/json,所以我不得不删除评论.

这是一个"你可以"的问题.这是一个"是"的答案.

不,您不应该使用重复的对象成员将侧信道数据填充到JSON编码中.(参见RFC中的 "对象中的名称应该是唯一的" ).

是的,你可以在JSON 周围插入注释,你可以解析它.

但是如果你想要一种插入和提取任意侧通道数据到有效JSON的方法,这里是一个答案.我们利用JSON编码中的非唯一数据表示.在RFC的第二部分中允许^*允许在"六个结构字符中的任何一个之前或之后允许空格".

^* RFC仅声明"在六个结构字符中的任何一个之前或之后允许空白",未明确提及字符串,数字,"false","true"和"null".在所有实现中都忽略了这种省略.

首先,通过缩小它来规范化您的JSON:

$jsonMin = json_encode(json_decode($json));

然后用二进制编码你的评论:

$hex = unpack('H*', $comment);
$commentBinary = base_convert($hex[1], 16, 2);

然后steg你的二进制文件:

$steg = str_replace('0', ' ', $commentBinary);
$steg = str_replace('1', "\t", $steg);

这是你的输出:

$jsonWithComment = $steg . $jsonMin;

免责声明：这很傻

实际上，有一种添加注释并保持在规范内的方法（无需其他解析器）。但是，如果不进行任何形式的解析，它将不会导致人类可读的注释。

您可能会滥用以下内容：

在任何令牌之前或之后都可以使用无关紧要的空格。空格是以下一个或多个代码点的任意序列：字符列表（U + 0009），换行符（U + 000A），回车符（U + 000D）和空格（U + 0020）。

您可以滥用这种方式添加评论。例如：用标签开始和结束您的评论。在base3中编码注释，并使用其他空格字符表示它们。例如。

010212 010202 011000 011000 011010 001012 010122 010121 011021 010202 001012 011022 010212 011020 010202 010202

（hello base three以ASCII表示），而不是0使用空格，对于1使用换行，对于2使用回车。

这只会给您留下很多不可读的空格（除非您制作一个IDE插件来对其进行动态编码/解码）。

由于明显的原因，我什至从未尝试过，您也不应该尝试。

我们正在使用strip-json-comments我们的项目.它支持以下内容:

/*
 * Description 
*/
{
    // rainbows
    "unicorn": /* ? */ "cake"
}

只需npm install --save strip-json-comments安装和使用它,如:

var strip_json_comments = require('strip-json-comments')
var json = '{/*rainbows*/"unicorn":"cake"}';
JSON.parse(strip_json_comments(json));
//=> {unicorn: 'cake'}

要将JSON项目切割成部分,我添加"虚拟注释"行:

{

"#############################" : "Part1",

"data1"             : "value1",
"data2"             : "value2",

"#############################" : "Part2",

"data4"             : "value3",
"data3"             : "value4"

}

JSON本身不允许评论。推理是完全愚蠢的，因为您可以使用JSON 本身来创建注释，从而完全避免推理，并且完全没有理由完全加载解析器数据空间，以得到完全相同的结果和潜在问题，例如：JSON带有注释的文件。

如果尝试（使用//或/* */或#例如）放入注释，则某些解析器将失败，因为这严格不在JSON规范之内。因此，您绝对不要那样做。

例如，在这里，我的图像处理系统保存了图像符号和一些与它们有关的基本格式化（注释）信息（在底部）：

{
    "Notations": [
        {
            "anchorX": 333,
            "anchorY": 265,
            "areaMode": "Ellipse",
            "extentX": 356,
            "extentY": 294,
            "opacity": 0.5,
            "text": "Elliptical area on top",
            "textX": 333,
            "textY": 265,
            "title": "Notation 1"
        },
        {
            "anchorX": 87,
            "anchorY": 385,
            "areaMode": "Rectangle",
            "extentX": 109,
            "extentY": 412,
            "opacity": 0.5,
            "text": "Rect area\non bottom",
            "textX": 98,
            "textY": 385,
            "title": "Notation 2"
        },
        {
            "anchorX": 69,
            "anchorY": 104,
            "areaMode": "Polygon",
            "extentX": 102,
            "extentY": 136,
            "opacity": 0.5,
            "pointList": [
                {
                    "i": 0,
                    "x": 83,
                    "y": 104
                },
                {
                    "i": 1,
                    "x": 69,
                    "y": 136
                },
                {
                    "i": 2,
                    "x": 102,
                    "y": 132
                },
                {
                    "i": 3,
                    "x": 83,
                    "y": 104
                }
            ],
            "text": "Simple polygon",
            "textX": 85,
            "textY": 104,
            "title": "Notation 3"
        }
    ],
    "imageXW": 512,
    "imageYW": 512,
    "imageName": "lena_std.ato",
    "tinyDocs": {
        "c01": "JSON image notation data:",
        "c02": "-------------------------",
        "c03": "",
        "c04": "This data contains image notations and related area",
        "c05": "selection information that provides a means for an",
        "c06": "image gallery to display notations with elliptical,",
        "c07": "rectangular, polygonal or freehand area indications",
        "c08": "over an image displayed to a gallery visitor.",
        "c09": "",
        "c10": "X and Y positions are all in image space. The image",
        "c11": "resolution is given as imageXW and imageYW, which",
        "c12": "you use to scale the notation areas to their proper",
        "c13": "locations and sizes for your display of the image,",
        "c14": "regardless of scale.",
        "c15": "",
        "c16": "For Ellipses, anchor is the  center of the ellipse,",
        "c17": "and the extents are the X and Y radii respectively.",
        "c18": "",
        "c19": "For Rectangles, the anchor is the top left and the",
        "c20": "extents are the bottom right.",
        "c21": "",
        "c22": "For Freehand and Polygon area modes, the pointList",
        "c23": "contains a series of numbered XY points. If the area",
        "c24": "is closed, the last point will be the same as the",
        "c25": "first, so all you have to be concerned with is drawing",
        "c26": "lines between the points in the list. Anchor and extent",
        "c27": "are set to the top left and bottom right of the indicated",
        "c28": "region, and can be used as a simplistic rectangular",
        "c29": "detect for the mouse hover position over these types",
        "c30": "of areas.",
        "c31": "",
        "c32": "The textx and texty positions provide basic positioning",
        "c33": "information to help you locate the text information",
        "c34": "in a reasonable location associated with the area",
        "c35": "indication.",
        "c36": "",
        "c37": "Opacity is a value between 0 and 1, where .5 represents",
        "c38": "a 50% opaque backdrop and 1.0 represents a fully opaque",
        "c39": "backdrop. Recommendation is that regions be drawn",
        "c40": "only if the user hovers the pointer over the image,",
        "c41": "and that the text associated with the regions be drawn",
        "c42": "only if the user hovers the pointer over the indicated",
        "c43": "region."
    }
}

有一个很好的解决方案(hack),它是有效的JSON.只需两次(或更多)相同的密钥.例如:

{
  "param" : "This is the comment place",
  "param" : "This is value place",
}

所以JSON会将其理解为:

{
  "param" : "This is value place",
}

JSON的作者希望我们在JSON中包含注释,但在解析它们之前将它们删除(参见Michael Burr提供的链接).如果JSON应该有注释,为什么不标准化它们,让JSON解析器完成这项工作呢？我不同意那里的逻辑,但是,唉,这是标准.使用其他人建议的YAML解决方案很好,但它需要库依赖.

如果你想删除注释,但又不想拥有库依赖,那么这是一个两行解决方案,适用于C++风格的注释,但可以适用于其他人:

var comments = new RegExp("//.*", 'mg');
data = JSON.parse(fs.readFileSync(sample_file, 'utf8').replace(comments, ''));

请注意,此解决方案只能用于您可以确保JSON数据不包含注释启动器的情况,例如('//').

另一种实现JSON解析,删除注释以及没有额外库的方法是在JavaScript解释器中评估JSON.当然,使用这种方法的警告是,您只想评估无污染的数据(没有不受信任的用户输入).这是Node.js中这种方法的一个例子 - 另一个警告,下面的例子只会读取一次数据,然后它将被缓存:

data = require(fs.realpathSync(doctree_fp));

如果将JSON加载为文本文件,则可以在其中使用带注释的JSON,然后从中删除注释.

您可以使用decomment库.以下是一个完整的例子.

输入JSON(文件input.js):

/*
* multi-line comments
**/
{
    "value": 123 // one-line comment
}

测试应用:

var decomment = require('decomment');
var fs = require('fs');

fs.readFile('input.js', 'utf8', function (err, data) {
    if (err) {
        console.log(err);
    } else {
        var text = decomment(data); // removing comments
        var json = JSON.parse(text); // parsing JSON
        console.log(json);
    }
});

输出:

{ value: 123 }

另见:gulp-decomment,grunt-decomment

就我而言，我需要在JSON结构的输出之前使用注释进行调试。因此，我决定在HTTP标头中使用调试信息，以避免破坏客户端：

header("My-Json-Comment: Yes, I know it's a workaround ;-) ");

我刚刚发现了" grunt-strip-json-comments ".

"从JSON中删除评论.它允许您在JSON文件中使用注释!"

{
    // Rainbows
    "unicorn": /* ? */ "cake"
}

叹.为什么不直接添加字段,例如

{
    "note1" : "This demonstrates the provision of annotations within a JSON file",
    "field1" : 12,
    "field2" : "some text",

    "note2" : "Add more annotations as necessary"
}

只需确保您的"notex"名称不与任何真实字段冲突.

VSCode用户在2019年的实际答案是使用'jsonc'扩展名。

实用，因为这是VSCode识别的扩展，用于指示“带注释的JSON”。请在下面的评论中让我了解其他编辑器/ IDE。

如果VSCode和其他编辑器也添加对'json5'的本机支持，那就太好了，但是目前VSCode仅包括对'jsonc'的支持。

（我在发布此内容之前搜索了所有答案，但都没有提及“ jsonc”。）

如果您的上下文是Node.js配置，则可以考虑通过JavaScript module.exports作为JSON的替代方案：

module.exports = {
    "key": "value",

    // And with comments!
    "key2": "value2"
};

该require语法仍然是相同的。作为JavaScript，文件扩展名应该为.js。

您可以通过正则表达式使用简单的预处理。例如，以下函数将在PHP中解码带注释的JSON：

function json_decode_commented ($data, $objectsAsArrays = false, $maxDepth = 512, $opts = 0) {
  $data = preg_replace('~
    (" (?:[^"\\\\] | \\\\\\\\ | \\\\")*+ ") | \# [^\v]*+ | // [^\v]*+ | /\* .*? \*/
  ~xs', '$1', $data);

  return json_decode($data, $objectsAsArrays, $maxDepth, $opts);
}

它支持所有PHP样式的注释：/ *，＃，//。字符串文字原样保留。

手机用户2402852387

这个屌丝很懒，什么也没留下！

关注作者

Tags | 热门标签

• actionscrip
• bash
• c#
• c++
• c语言
• erlang
• flutter
• go
• golang
• java
• javascript
• lua
• node.js
• perl
• php
• python
• scala
• typescript

RankList | 热门文章

• 1如何使用数据注释在EF 7 Code First中指定唯一键
• 2OpenCV Mat数据成员访问
• 3设计rails current_user与user_signed_in？
• 4.removeClass用于多个缓存选择器
• 5MSBuild和<AutoUnifyAssemblyReferences />
• 6为什么我不能插入/插入我的地图？
• 7在dagre-d3中为节点分配超链接
• 8我应该如何在typedef中定义一组位数？
• 9在android中动态设置状态栏颜色
• 10Android-Skobbler不支持64位处理器
• 11DIV:全高+滚动
• 12为什么定义析构函数会删除隐式定义的移动赋值运算符？
• 13UIImageView在启动屏幕上是黑色的
• 14传递char**作为参数
• 15如何与MongoDb C#Driver 2.1异步使用AsQueryable方法？
• 16PolymerJS:Iron-Ajax - 如何将令牌绑定到标题属性？
• 17Shell脚本使用不清楚":"
• 18我怎样才能确保非法行为是不可行的？
• 19使用html2canvas将高图图表呈现为pdf不适用于IE和Firefox
• 20Postgres 9.4中JSON - > JSONB列转换的速度大致有多快

DevBox开发工具箱 | 专业的在线开发工具网站    京公网安备 11010802040832号  |  京ICP备19059560号-6
Copyright © 1998 - 2020 DevBox.CN. All Rights Reserved devBox.cn 开发工具箱 版权所有