添加 json 文件注释

2022-08-30 12:58:36

可能的重复:
我可以注释 JSON 文件吗?

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

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

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

对于 JSON 文件,是否有可接受的注释形式?


答案 1

JSON不支持注释 - 当你想到它时,这很好。但是,有人已经制作了JSON5(https://github.com/aseemk/json5),它确实做到了,并且可能对您有用。

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


答案 2

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

它是一种用于存储和传输数据的轻量级格式。如果注释确实很重要,则可以将其作为另一个数据字段(如 ) 包含在内。comments: "my comment"

例如:

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

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