添加json文件注释

时间:2012-06-25 18:28:00

标签: php javascript json comments

  

可能重复:
  Can I comment a JSON file?

我们在项目中使用.json文件。我们想知道是否可以向文件添加注释并避免崩溃JSON解析器。

我们尝试使用以下注释类型执行此操作,但它们在解析时都会使JSON文件崩溃:

# I crash
// I crash
/* I crash */

是否有可接受的JSON文件评论形式?

2 个答案:

答案 0 :(得分:18)

JSON不支持评论 - 当你考虑它时这很好。但是,有人制作了JSON5(https://github.com/aseemk/json5),这对您有用,并且对您有用。

值得指出的是,这只是某些类似JSON的项目,并不是官方规范,但后来我猜JSON只是人们喜欢的类似XML的项目:)

答案 1 :(得分:11)

标准JSON格式未明确支持文件注释。 RFC 4627 application/json

这是一种用于存储和传输数据的轻量级格式。如果评论真的很重要,您可以将其包含在comments: "my comment"等其他数据字段中。

e.g。

{
    name: "Bob",
    age: 5,
    comments: "I don't like him"
}

但是,如果它以这种格式使用,它实际上只是另一条数据。所以最终,你必须意识到的是,仅仅因为某些领域并不意味着你必须使用它。