协慌网

登录 贡献 社区

可以在 JSON 中使用注释吗?

1
88250
贡献值 30
贡献次数 1

可以在 JSON 文件中使用注释吗?如果可以,应该怎样做?

答案

1
88250
贡献值 295
贡献次数 1

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"
            }
         }
      }
   }
}