[英]Can comments be used in JSON?
不。
JSON 是純數據的。 如果您包含評論，那么它也必須是數據。
您可能有一個名為"_comment" （或其他名稱）的指定數據元素，使用 JSON 數據的應用程序應忽略該數據元素。
您可能會更好地在生成/接收 JSON 的過程中添加注釋，因為他們應該提前知道 JSON 數據是什么，或者至少知道它的結構。
但是，如果您決定：
{
"_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"
}
}
}
}
}
不，JSON 中不允許使用//…或/*…*/形式的注釋。 這個答案基於：
application/json媒體類型如果您願意，請包括評論； 在解析或傳輸之前用壓縮器將它們剝離。
我剛剛發布了JSON.minify() ，它從 JSON 塊中去除注釋和空格，使其成為可以解析的有效 JSON。 因此，您可以像這樣使用它：
JSON.parse(JSON.minify(my_str));
當我發布它時，我遭到了很多人的強烈反對，甚至不同意它的想法，所以我決定寫一篇全面的博客文章，解釋為什么評論在 JSON 中有意義。 它包括來自 JSON 的創建者的這條值得注意的評論：
假設您使用 JSON 來保存您想要注釋的配置文件。 繼續並插入您喜歡的所有評論。 然后通過 JSMin 將其通過管道傳遞給您的 JSON 解析器。 - 道格拉斯·克羅克福德，2012
希望這對那些不同意JSON.minify()有用的人有所幫助。
設計上從 JSON 中刪除了評論。
我從 JSON 中刪除了注釋，因為我看到人們使用它們來保存解析指令，這種做法會破壞互操作性。 我知道缺少評論會讓一些人感到難過，但不應該。
假設您使用 JSON 來保存您想要注釋的配置文件。 繼續並插入您喜歡的所有評論。 然后通過 JSMin 將其通過管道傳遞給您的 JSON 解析器。
JSON 不支持評論。 它也從未打算用於需要注釋的配置文件。
Hjson 是人類的配置文件格式。 輕松的語法，更少的錯誤，更多的評論。
有關 JavaScript、Java、Python、PHP、Rust、Go、Ruby、C++ 和 C# 庫的信息，請參見hjson.github.io 。
免責聲明：您的保修無效
正如已經指出的那樣，這個黑客利用了規范的實現。 並非所有 JSON 解析器都能理解這種 JSON。 特別是流式解析器會窒息。
這是一個有趣的好奇心，但你真的不應該將它用於任何事情。 以下是原答案。
我發現了一個小技巧，可以讓您在 JSON 文件中放置注釋，這不會影響解析，或以任何方式更改所表示的數據。
似乎在聲明對象文字時，您可以使用相同的鍵指定兩個值，並且最后一個優先。 信不信由你，事實證明 JSON 解析器的工作方式相同。 因此，我們可以使用它在源 JSON 中創建不會出現在已解析對象表示中的注釋。
({a: 1, a: 2});
// => Object {a: 2}
Object.keys(JSON.parse('{"a": 1, "a": 2}')).length;
// => 1
如果我們應用此技術，您的注釋 JSON 文件可能如下所示：
{
"api_host" : "The hostname of your API server. You may also specify the port.",
"api_host" : "hodorhodor.com",
"retry_interval" : "The interval in seconds between retrying failed API calls",
"retry_interval" : 10,
"auth_token" : "The authentication token. It is available in your developer dashboard under 'Settings'",
"auth_token" : "5ad0eb93697215bc0d48a7b69aa6fb8b",
"favorite_numbers": "An array containing my all-time favorite numbers",
"favorite_numbers": [19, 13, 53]
}
上面的代碼是有效的 JSON 。 如果你解析它，你會得到一個像這樣的對象：
{
"api_host": "hodorhodor.com",
"retry_interval": 10,
"auth_token": "5ad0eb93697215bc0d48a7b69aa6fb8b",
"favorite_numbers": [19,13,53]
}
這意味着沒有評論的痕跡，也不會產生奇怪的副作用。
快樂黑客！
考慮使用YAML 。 它幾乎是 JSON 的超集（實際上所有有效的 JSON 都是有效的 YAML）並且它允許注釋。
你不能。 至少這是我快速瀏覽json.org的經驗。
JSON 的語法在該頁面上可視化。 沒有關於評論的任何注釋。
注釋不是官方標准，盡管一些解析器支持 C++ 樣式的注釋。 我使用的一個是JsonCpp 。 在示例中有一個：
// Configuration options
{
// Default encoding for text
"encoding" : "UTF-8",
// Plug-ins loaded at start-up
"plug-ins" : [
"python",
"c++",
"ruby"
],
// Tab indent size
"indent" : { "length" : 3, "use_space": true }
}
jsonlint不驗證這一點。 所以注釋是解析器特定的擴展而不是標准的。
另一個解析器是JSON5 。
JSON TOML的替代方案。
另一種選擇是jsonc 。
最新版本的nlohmann/json提供了對忽略解析注釋的可選支持。
以下是我在Google Firebase 文檔中找到的，它允許您在 JSON 中添加評論：
{
"//": "Some browsers will use this to enable push notifications.",
"//": "It is the same for all projects, this is not your project's sender ID",
"gcm_sender_id": "1234567890"
}
您應該改為編寫JSON 模式。 JSON 模式目前是一個提議的 Internet 草案規范。 除了文檔之外，該模式還可用於驗證您的 JSON 數據。
例子：
{
"description":"A person",
"type":"object",
"properties":
{
"name":
{
"type":"string"
},
"age":
{
"type":"integer",
"maximum":125
}
}
}
您可以使用描述架構屬性來提供文檔。
如果您使用Jackson作為您的 JSON 解析器，那么這就是您啟用它以允許評論的方式：
ObjectMapper mapper = new ObjectMapper().configure(Feature.ALLOW_COMMENTS, true);
然后你可以有這樣的評論：
{
key: "value" // Comment
}
您還可以通過設置以#開頭的注釋：
mapper.configure(Feature.ALLOW_YAML_COMMENTS, true);
但總的來說（如前所述）規范不允許評論。
沒有。 JSON 曾經支持評論，但它們被濫用並從標准中刪除。
來自 JSON 的創建者：
我從 JSON 中刪除了注釋，因為我看到人們使用它們來保存解析指令，這種做法會破壞互操作性。 我知道缺少評論會讓一些人感到難過，但不應該。 - 道格拉斯·克羅克福德，2012
JSON 官方網站位於JSON.org 。 JSON 被 ECMA International 定義為標准。 總是有一個請求過程來修改標准。 出於多種原因，不太可能將注釋添加到 JSON 標准中。
JSON 在設計上是一種易於逆向工程（人工解析）的 XML 替代方案。 它甚至被簡化到不需要注釋的地步。 它甚至不是一種標記語言。 目標是穩定性和互操作性。
任何理解面向對象的“具有”關系的人都可以理解任何 JSON 結構——這就是重點。 它只是一個帶有節點標簽（鍵/值對）的有向無環圖（DAG），是一種近乎通用的數據結構。
唯一需要的注釋可能是“//這些是 DAG 標記”。 鍵名可以根據需要提供信息，允許任意語義。
任何平台都可以只用幾行代碼解析 JSON。 XML 需要復雜的 OO 庫，這些庫在許多平台上不可行。
注釋只會降低 JSON 的互操作性。 除非您真正需要的是標記語言 (XML)，否則根本沒有其他要添加的內容，並且不關心您的持久數據是否易於解析。
但是正如 JSON 的創建者也觀察到的那樣，JS 管道一直支持評論：
繼續並插入您喜歡的所有評論。 然后通過 JSMin 將其通過管道傳遞給您的 JSON 解析器。 - 道格拉斯·克羅克福德，2012
如果您使用帶有 ASP.NET 的 Newtonsoft.Json 庫來讀取/反序列化，您可以在 JSON 內容中使用注釋：
//“名稱”：“字符串”
//"id": int
或者
/* 這是一個
評論示例 */
PS：單行注釋僅支持 6+ 版本的 Newtonsoft Json。
對無法開箱即用的人的附加說明：我在我制作的 ASP.NET Web 應用程序中使用 JSON 格式進行基本設置。 我閱讀了該文件，使用 Newtonsoft 庫將其轉換為設置對象，並在必要時使用它。
我更喜歡在 JSON 文件本身中寫關於每個單獨設置的注釋，而且我真的不關心 JSON 格式的完整性，只要我使用的庫可以接受它。
我認為這是一種比創建單獨的“settings.README”文件並解釋其中的設置更容易使用/理解的方式。
如果您對這種用法有疑問； 對不起，精靈不在燈里了。 人們會發現 JSON 格式的其他用途，對此您無能為力。
如果您的文本文件（一個 JSON 字符串）將被某個程序讀取，那么在使用它之前去掉 C 或 C++ 樣式的注釋會有多困難？
答：應該是單排。 如果你這樣做，那么 JSON 文件可以用作配置文件。
JSON 本身不支持評論，但是您可以制作自己的解碼器或至少預處理器來去除評論，這非常好（只要您忽略評論並且不使用它們來指導您的應用程序應該如何處理 JSON 數據）。
JSON 沒有評論。 JSON 編碼器不得輸出評論。 JSON 解碼器可以接受和忽略評論。
永遠不應該使用評論來傳遞任何有意義的東西。 這就是 JSON 的用途。
JSON 背后的想法是在應用程序之間提供簡單的數據交換。 這些通常是基於網絡的，語言是 JavaScript。
它實際上不允許這樣的注釋，但是，將注釋作為數據中的名稱/值對之一傳遞肯定會起作用，盡管該數據顯然需要被解析代碼忽略或專門處理。
綜上所述，JSON 文件不應該包含傳統意義上的注釋。 它應該只是數據。
查看JSON 網站了解更多詳細信息。
我只是在配置文件中遇到這個。 我不想使用XML （冗長、圖形化、丑陋、難以閱讀）或“ini”格式（沒有層次結構、沒有真正的標准等）或 Java“Properties”格式（如 .ini）。
JSON 可以做他們能做的所有事情，但它不那么冗長，而且更易於閱讀——而且解析器在許多語言中都很容易且無處不在。 它只是一棵數據樹。 但是帶外注釋通常是記錄“默認”配置等的必要條件。 配置永遠不會是“完整文檔”，而是在需要時可供人類閱讀的已保存數據樹。
我想可以使用"#": "comment"來表示“有效” JSON。
這取決於您的 JSON 庫。 Json.NET支持 JavaScript 樣式的注釋/* commment */ 。
JSON 對於配置文件和其他本地使用很有意義，因為它無處不在，而且比 XML 簡單得多。
如果人們在交流數據（無論是否有效）時有充分的理由反對在 JSON 中添加評論，那么 JSON 可能會被分成兩部分：
JSON-DOC 將允許注釋，並且可能存在其他細微差異，例如處理空格。 解析器可以輕松地從一種規范轉換為另一種規范。
關於 Douglas Crockford 對此問題的評論（@Artur Czajka 引用）
假設您使用 JSON 來保存您想要注釋的配置文件。 繼續並插入您喜歡的所有評論。 然后通過 JSMin 將其通過管道傳遞給您的 JSON 解析器。
我們正在談論一個通用的配置文件問題（跨語言/平台），而他正在用一個 JS 特定的實用程序來回答！
當然，特定於 JSON 的縮小可以用任何語言實現，但是將其標准化，以便它在所有語言和平台的解析器中無處不在，這樣人們就不會因為缺少該功能而浪費時間，因為他們有很好的用例，在在線論壇，並讓人們告訴他們這是一個壞主意，或者建議很容易實現從文本文件中刪除評論。
另一個問題是互操作性。 假設您有一個庫或 API 或任何類型的子系統，其中有一些與之關聯的配置或數據文件。 並且這個子系統可以從不同的語言中訪問。 然后你會告訴人們：順便說一下，在將 JSON 文件傳遞給解析器之前不要忘記從 JSON 文件中刪除注釋！
是的，新標准JSON5允許 C++ 樣式注釋以及許多其他擴展：
// A single line comment.
/* A multi-
line comment. */
JSON5 數據交換格式 (JSON5) 是 JSON 的超集，旨在減輕 JSON 的一些限制。 它完全向后兼容，並且使用它可能比編寫自定義非標准解析器、為現有解析器打開非標准功能或使用各種技巧（如字符串字段進行注釋）更好。 或者，如果使用的解析器支持，只需同意我們使用的是 JSON 5 子集，即 JSON 和 C++ 樣式的注釋。 它比我們以我們認為合適的方式調整 JSON 標准要好得多。
已經有npm 包、 Python 包、 Java 包和C 庫可用。 它向后兼容。 我認為沒有理由堅持“官方”JSON 限制。
我認為從 JSON 中刪除注釋的原因與在 Java 中刪除運算符重載的原因相同：可能會以錯誤的方式使用，但忽略了一些明顯合法的用例。 對於運算符重載，它是矩陣代數和復數。 對於 JSON 注釋，它是可以由人類編寫、編輯或讀取的配置文件和其他文檔，而不僅僅是解析器。
Dojo Toolkit JavaScript 工具包（至少從 1.4 版開始）允許您在 JSON 中包含注釋。 注釋可以是/* */格式。 Dojo Toolkit 通過dojo.xhrGet()調用使用 JSON。
其他 JavaScript 工具包也可以類似地工作。
在選擇最終選項之前嘗試替代數據結構（甚至數據列表）時，這會很有幫助。
您可以在JSONP中發表評論，但不能在純 JSON 中發表評論。 我剛剛花了一個小時試圖讓我的程序與Highcharts 中的這個示例一起工作。
如果你點擊鏈接，你會看到
?(/* AAPL historical OHLC data from the Google Finance API */
[
/* May 2006 */
[1147651200000,67.79],
[1147737600000,64.98],
...
[1368057600000,456.77],
[1368144000000,452.97]
]);
由於我的本地文件夾中有一個類似的文件，因此Same-origin policy沒有問題，所以我決定使用純 JSON……當然， $.getJSON因為評論而默默地失敗了。
最后，我只是向上面的地址發送了一個手動 HTTP 請求，並意識到內容類型是text/javascript ，因為 JSONP 返回純 JavaScript。 在這種情況下，評論是允許的。 但是我的應用程序返回了 content-type application/json ，所以我不得不刪除評論。
JSON 不是框架協議。 它是一種無語言格式。 所以評論的格式沒有為 JSON 定義。
正如許多人所建議的那樣，有一些技巧，例如，您可以使用重復鍵或特定鍵_comment 。 由你決定。
免責聲明：這很愚蠢
實際上有一種方法可以添加注釋並保持在規范范圍內（不需要額外的解析器）。 但是，如果沒有任何類型的解析，它不會產生人類可讀的評論。
您可能會濫用以下內容：
在任何標記之前或之后都允許使用無關緊要的空格。 空格是以下一個或多個代碼點的任意序列：字符制表 (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
（ ASCII 中的hello base three ）但不是 0 使用空格，1 使用換行，2 使用回車。
這只會給你留下很多不可讀的空白（除非你制作一個 IDE 插件來動態編碼/解碼它）。
出於明顯的原因，我什至從未嘗試過，你也不應該這樣做。
這是一個“你能不能”的問題。 這是一個“是”的答案。
不，您不應該使用重復的對象成員將側通道數據填充到 JSON 編碼中。 （請參閱RFC 中的“對象內的名稱應該是唯一的”）。
是的，您可以在 JSON周圍插入注釋，您可以解析出來。
但是，如果您想要一種將任意側通道數據插入和提取到有效 JSON 的方法，這里有一個答案。 我們利用 JSON 編碼中數據的非唯一表示。 這是允許的*在 RFC 的第二部分“在六個結構字符中的任何一個之前或之后允許空白”。
首先，通過縮小 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;
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."
}
}
就我而言，我需要在 JSON 輸出之前使用注釋進行調試。 所以我把調試信息放在HTTP 頭中，避免破壞客戶端：
header("My-Json-Comment: Yes, I know it's a workaround ;-) ");
我們正在為我們的項目使用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 中包含注釋，但在解析它們之前將它們去掉（參見 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 }
嘆。 為什么不只是添加字段，例如
{
"note1" : "This demonstrates the provision of annotations within a JSON file",
"field1" : 12,
"field2" : "some text",
"note2" : "Add more annotations as necessary"
}
只要確保您的“notex”名稱不與任何真實字段沖突。
我剛剛找到“ grunt-strip-json-comments ”。
“從 JSON 中刪除評論。 它允許您在 JSON 文件中使用注釋！”
{
// Rainbows
"unicorn": /* ❤ */ "cake"
}
正如JSON 的發明者所說：
JSON 沒有評論。 JSON 編碼器不得輸出評論。 JSON 解碼器可以接受和忽略評論。
實用程序jq包含一個允許“#”樣式注釋的解碼器，因此 jq 是可以與 JSON-with-comments 文件結合使用的幾種工具之一，只要這些文件被視為“jq 程序”，而不是 JSON 文件。 例如：
$ jq -ncf <(echo $'[1, # one\n2 ] # two')
[1,2]
更重要的是，jq 可以將非常大的帶有注釋的 JSON 文件作為程序處理； 這可以使用眾所周知的 JSON 文件來說明：
$ ls -l JEOPARDY_QUESTIONS1.json
-rw-r--r-- 2 xyzzy staff 55554625 May 12 2016 JEOPARDY_QUESTIONS1.json
$ jq -nf JEOPARDY_QUESTIONS1.json | jq length
216930
有一個很好的解決方案（hack），它是有效的 JSON，但並非在所有情況下都有效（請參閱下面的評論）。 只需兩次（或更多）相同的密鑰。 例如：
{
"param" : "This is the comment place",
"param" : "This is value place",
}
所以 JSON 會將其理解為：
{
"param" : "This is value place",
}
2019 年Visual Studio Code用戶的實際答案是使用“jsonc”擴展。
這很實用，因為這是 Visual Studio Code 識別的擴展名，表示“帶有注釋的 JSON”。 請在下面的評論中讓我知道其他編輯器/IDE。
如果 Visual Studio Code 和其他編輯器也能添加對 JSON5 的本機支持，那就太好了，但目前 Visual Studio Code 僅包含對“jsonc”的支持。
（我在發布之前搜索了所有答案，沒有提到'jsonc'。）
如果您的上下文是 Node.js 配置，您可能會考慮通過module.exports使用 JavaScript 作為 JSON 的替代方案：
module.exports = {
"key": "value",
// And with comments!
"key2": "value2"
};
require語法仍然相同。 作為 JavaScript，文件擴展名應該是.js 。
純粹的答案是否定的。
但是一些編輯器和平台使用變通方法向 JSON 添加注釋。
1 . 如今，大多數編輯器都有內置選項和擴展來向 JSON 文檔添加注釋。 （例如：- VS Code 也有一個帶有注釋(jsonc) mode的 JSON / VS Code 也有很好的擴展）
2 . 一些平台提供了內置的方式來添加評論（不純的 json）。 （例如：- 在 firebase 中，我可以評論firebase.json一段時間而不會出現問題。
{
"hosting": {
"headers": [
/*{
"source": "*.html",
"headers": [
{
"key": "Content-Security-Policy",
"value": "default-src 'self' ..."
}
]
},*/
]
}
}
3 . 在您自己的 JSON 解析方法中，您可以將預定義的鍵名設置為注釋。
例如：-
{
"comment" : "This is a comment",
"//" : "This also comment",
"name" : "This is a real value"
}
正如許多答案已經指出的那樣，JSON 本身沒有評論。 當然，有時你還是想要它們。 對於Python ，有兩種方法是使用commentjson （ #和//僅用於 Python 2）或json_tricks （ #或//用於 Python 2 和 Python 3），它具有其他幾個功能。 免責聲明：我制作了json_tricks 。
json 規范不支持評論，但您可以通過將評論寫為鍵來解決該問題，就像這樣
{
"// my own comment goes here":"",
"key1":"value 1",
"// another comment goes here":"",
"key 2": "value 2 here"
}
通過這種方式，我們使用注釋文本作為鍵，確保（幾乎）它們是唯一的並且它們不會破壞任何解析器。 如果您的某些評論不是唯一的，請在最后添加隨機數。
如果您需要解析注釋以執行任何處理（例如剝離它們），您可以使用指示它是注釋的文本填充注釋值，如下所示：
{
"// my own comment goes here" : "_comment",
"key1":"value 1",
"// another comment goes here" : "_comment",
"key 2": "value 2 here"
}
這樣解析器可以找到所有注釋並處理它們。
您可以通過正則表達式使用簡單的預處理。 例如，以下函數將解碼 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 樣式的注釋：/*、#、//。 字符串文字按原樣保留。
是的，您可以發表評論。 但我不會推薦上面提到的任何理由。
我做了一些調查，發現所有 JSON 要求方法都使用JSON.parse方法。 所以我想出了一個解決方案：我們可以覆蓋 JSON.parse 或做猴子補丁。
注意：僅在 Node.js 上測試過；-)
var oldParse = JSON.parse;
JSON.parse = parse;
function parse(json){
json = json.replace(/\/\*.+\*\//, function(comment){
console.log("comment:", comment);
return "";
});
return oldParse(json)
}
JSON文件：
{
"test": 1
/* Hello, babe */
}
*.json 文件一般用作配置文件或靜態數據，因此需要注釋 → 有些編輯器（如 NetBeans）接受 *.json 中的注釋。
問題是將內容解析為對象。 解決方案是始終應用清理功能（服務器或客戶端）。
###PHP
$rgx_arr = ["/\/\/[^\n]*/sim", "/\/\*.*?\*\//sim", "/[\n\r\t]/sim"];
$valid_json_str = \preg_replace($rgx_arr, '', file_get_contents(path . 'a_file.json'));
###JavaScript
valid_json_str = json_str.replace(/\/\/[^\n]*/gim,'').replace(/\/\*.*?\*\//gim,'')
當然你可以評論 JSON。 要從 JavaScript 中讀取帶注釋的 JSON 文件，您可以在解析之前去除注釋（參見下面的代碼）。 我確信這段代碼可以改進，但是對於那些使用正則表達式的人來說很容易理解。
我使用帶注釋的 JSON 文件為我的合成反射系統指定神經元形狀。 我還使用帶注釋的 JSON 來存儲正在運行的神經元系統的中間狀態。 發表評論非常方便。 不要聽那些告訴你他們是個壞主意的教條。
fetch(filename).then(function(response) {
return response.text();
}).then(function(commented) {
return commented.
replace(/\/\*[\s\S]*?\*\/|([^\\:]|^)\/\/.*$/gm, '$1').
replace(/\r/,"\n").
replace(/\n[\n]+/,"\n");
}).then(function(clean) {
return JSON.parse(clean);
}).then(function(json) {
// Do what you want with the JSON object.
});
在撰寫本文時， appsettings.json支持評論。
例如（ 示例由 Microsoft 提供）
{
"Logging": {
"LogLevel": { // All providers, LogLevel applies to all the enabled providers.
"Default": "Error", // Default logging, Error and higher.
"Microsoft": "Warning" // All Microsoft* categories, Warning and higher.
},
"Debug": { // Debug provider.
"LogLevel": {
"Default": "Information", // Overrides preceding LogLevel:Default setting.
"Microsoft.Hosting": "Trace" // Debug:Microsoft.Hosting category.
}
},
"EventSource": { // EventSource provider
"LogLevel": {
"Default": "Warning" // All categories of EventSource provider.
}
}
}
}
雖然 JSON 不支持注釋，但 JSONC支持。
使用 '.jsonc' 擴展名命名您的文件並使用jsonc解析器。
抱歉，如果這個答案為時已晚。
jsonWithComments.jsonc
例子：
{
// This is a comment!
"something": "idk"
}
如果不清楚，我認為機器人很奇怪。 請在投票之前嘗試這個問題沒有幫助。
如果您使用的是 PHP，則可以使用此函數從 JSON 字符串中搜索並刪除 // /* 類型注釋，然后再將其解析為對象/數組：
function json_clean_decode($json, $assoc = true, $depth = 512, $options = 0) {
// search and remove comments like /* */ and //
$json = preg_replace("#(/\*([^*]|[\r\n]|(\*+([^*/]|[\r\n])))*\*+/)|([\s\t]//.*)|(^//.*)#", '', $json);
if(version_compare(phpversion(), '5.4.0', '>=')) {
$json = json_decode($json, $assoc, $depth, $options);
}
elseif(version_compare(phpversion(), '5.3.0', '>=')) {
$json = json_decode($json, $assoc, $depth);
}
else {
$json = json_decode($json, $assoc);
}
return $json;
}
希望這可以幫助！
您可以使用JSON-LD和schema.org 注釋類型來正確編寫注釋：
{
"https://schema.org/comment": "this is a comment"
}
整個線程假定添加注釋是需要對 JSON 進行的唯一改進。 如果有人不想要 JSON 中的注釋，因為它用於序列化，只需省略注釋。 空格也是如此。 但為什么要停在那里？ 為什么 JSON 中需要引號？ 他們沒有添加任何有用的東西。
我能想到的 JSON 如此僵化的唯一原因是解析是否困難。 但事實並非如此。 幾乎任何程序員都可以在任一方向編寫 JSON 解析器。
我希望 JSON 可讀且高效（簡短），並且對數據傳輸、配置文件等有用。 以下示例滿足了這兩個要求：
{stringA: stringB, stringC: stringD, [stringE, stringF]}
比任何現有的 JSON 規范都短，但同樣可讀且更高效。
需要在屬性或值中包含引號、撇號、逗號或括號嗎？ 只需將它們括在問號或撇號中（使用反斜杠轉義），就像在 JavaScript 中一樣。
但請讓引號可選。 為什么？ 因為 JSON 不能包含變量或函數名稱（以避免注入攻擊），所以引號不提供任何歧義。 我們已經知道所有的數據都是字符串。 所以，請先省略引號，除非確實需要。
還有其他與 JSON 兼容的庫，它們支持注釋。
一個值得注意的例子是“Hashcorp 語言”（HCL） 。它是由制作 Vagrant、packer、consul 和 vault 的同一個人編寫的。
我在當前項目中遇到了這個問題，因為我有相當多的 JSON 需要一些注釋以使事情易於記憶。
我使用這個簡單的 Python 函數來替換注釋並使用json.loads將其轉換為dict ：
import json, re
def parse_json(data_string):
result = []
for line in data_string.split("\n"):
line = line.strip()
if len(line) < 1 or line[0:2] == "//":
continue
if line[-1] not in "\,\"\'":
line = re.sub("\/\/.*?$", "", line)
result.append(line)
return json.loads("\n".join(result))
print(parse_json("""
{
// This is a comment
"name": "value" // so is this
// "name": "value"
// the above line gets removed
}
"""))
是的。 您可以將注釋放在 JSON 文件中。
{
"": "Location to post to",
"postUrl": "https://example.com/upload/",
"": "Username for basic auth",
"username": "joebloggs",
"": "Password for basic auth (note this is in clear, be sure to use HTTPS!",
"password": "bloejoggs"
}
注釋只是一段描述代碼塊或配置目的的文本。 而且因為您可以在 JSON 中多次指定鍵，所以您可以這樣做。 它在語法上是正確的，唯一的權衡是你的字典中有一個帶有垃圾值的空鍵（你可以修剪......）
我多年前就看到了這個問題，但我只是在我正在從事的項目中看到這樣做，我認為這是一種非常干凈的方法。 享受！
JSON 不支持注釋，但 YAML 支持內聯注釋（盡管沒有塊注釋）。 由於它們都是數據文件並且具有相似的功能，因此這可能是要走的路。 另外，網上有json2yaml.com之類的資源，可以輕松將JSON轉YAML
我真的很喜歡@eli 的方法，有 30 多個答案，但沒有人提到列表（數組）。 因此，使用@eli 的方法，我們可以執行以下操作：
"part_of_speech": {
"__comment": [
"@param {String} type - the following types can be used: ",
"NOUN, VERB, ADVERB, ADJECTIVE, PRONOUN, PREPOSITION",
"CONJUNCTION, INTERJECTION, NUMERAL, PARTICLE, PHRASE",
"@param {String} type_free_form - is optional, can be empty string",
"@param {String} description - is optional, can be empty string",
"@param {String} source - is optional, can be empty string"
],
"type": "NOUN",
"type_free_form": "noun",
"description": "",
"source": "https://google.com",
"noun_class": {
"__comment": [
"@param {String} noun_class - the following types can be used: ",
"1_class, 2_class, 3_class, 4_class, 5_class, 6_class"
],
"noun_class": "4_class"
}
}
不，您不能在 JSON 中使用注釋。 您最終可以在 JSON 對象中創建一個名為“評論”的字段，並在其中放置一條消息 :)。
我搜索了所有答案頁面，但沒有人在 GitHub 或 Stack Overflow 上提及有關 JSON 語法突出顯示的內容，盡管這個答案很接近。
一些 JSON 解析器接受 C++ 風格的注釋。 例如，要在 GitHub 或 Stack Overflow 上寫入 markdown 時觸發它們，您可以將語法高亮類型指定為jsonc 。 例子：
這個：
```jsonc
// C++-style comment here
{
"*.md": {
"softwrap": true
},
"colorcolumn": 80,
"savecursor": true,
"scrollbar": true,
"scrollspeed": 5,
"softwrap": true,
"wordwrap": true
}
```
產生這個：
// C++-style comment here
{
"*.md": {
"softwrap": true
},
"colorcolumn": 80,
"savecursor": true,
"scrollbar": true,
"scrollspeed": 5,
"softwrap": true,
"wordwrap": true
}
正如我上面提到的答案，您可以使用驚人的 nlohmann json C++ 庫解析 JSON，其中包含 C ( /* */ ) 和 C++ ( // ) 樣式注釋。
它在這里： https://github.com/nlohmann/json
您需要的單個 header 文件位於： https://github.com/nlohmann/json/blob/develop/include/nlohmann/json.hpp
那個圖書館是這樣說的： https://github.com/nlohmann/json#comments-in-json ：
評論JSON
這個庫默認不支持評論。 這樣做有以下三個原因：
- 注釋不是JSON 規范的一部分。 你可能會爭辯說
//或/* */在 JavaScript 中是允許的，但 JSON 不是 JavaScript。- 這不是疏忽：Douglas Crockford 在 2012 年 5 月就此寫道：
我從 JSON 中刪除了注釋，因為我看到人們使用它們來保存解析指令，這種做法會破壞互操作性。 我知道缺少評論會讓一些人難過，但不應該這樣。
假設您正在使用 JSON 來保存您想要注釋的配置文件。 Go 前面，插入所有你喜歡的評論。 然后 pipe 通過 JSMin，然后將其交給您的 JSON 解析器。
- 如果某些庫會添加評論支持而其他庫則不會，那么互操作性是危險的。 請檢查 健壯性原則的有害后果。
但是，您可以在
parsefunction 中將設置參數ignore_comments設置為 true 以忽略//或/* */注釋。 然后注釋將被視為空格。
ignore_comments是一個bool ，是傳遞給nlohmann::json::parse() function 的最后一個參數。請參閱此處： https://json.nlohmann.me/api/basic_json/parse/
參考：
技術上不是。 但您可以按如下方式解決。
{
"json": "actual data goes here, comments below",
"comment1": "Lorem ipsum dolor sit amet",
"comment2": "consectetur adipiscing elit"
}
只需將注釋放在數據中即可。 如果您對它們進行編號以使每個關鍵路徑唯一，那么您應該沒有問題。
JSON 中需要注釋，並且注釋至少在 .NET Core JSON 和 Newtonsoft Json 中可用。 完美運行。
{
// this is a comment for those who is ok with being different
"regular-json": "stuff"...
}
是的，你可以，但你的解析可能會失敗（沒有標准）。
要解析它，您應該刪除這些注釋，或者手動刪除，或者使用正則表達式：
它取代了任何評論，例如：
/****
* Hey
*/
/\/\*([^*]|[\r\n]|(\*+([^*/]|[\r\n])))*\*\/+/
它取代了任何評論，例如：
// Hey
/\/\/.*/
在 JavaScript 中，你可以這樣做：
jsonString = jsonString.replace(/\/\*([^*]|[\r\n]|(\*+([^*/]|[\r\n])))*\*\/+/, "").replace(/\/\/.*/,"")
var object = JSON.parse(jsonString);
“ JSON不支持注釋，因為開發人員曾經將指令傳遞給解析器”。 誰能解釋這意味着什么？
[英]“Comments are not Supported in JSON because developers used to pass instructions to the parser”. Can anyone explain what this means?
我如何處理讀取其中帶有 python 注釋的 .json 文件？
[英]How can I handle reading a .json file in it that has comments with python?
聲明:本站的技術帖子網頁，遵循CC BY-SA 4.0協議，如果您需要轉載，請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.