将 JSON 文件切换为允许注释的格式或使用变通方法

在 VS Code 中,JSON 文件默认不支持注释(如// ),任何添加注释的尝试都会导致编辑器将该行标记为错误。这是因为官方 JSON 规范不允许注释。

为了防止//注释被标记为红色,您需要将 JSON 文件切换为允许注释的格式或使用变通方法。以下是您可以尝试的几个选项:

选项 1:使用jsonc (带注释的 JSON)

VS Code 支持jsonc文件,它允许 JSON 结构和注释。您可以将文件扩展名从.json重命名为.jsonc ,它将支持注释。例如,将yourfile.json重命名为yourfile.jsonc

选项 2:添加jsonc语法高亮(如果您希望保留.json扩展名)

如果你不愿意更改文件扩展名,你仍然可以通过添加适当的配置来使用带有jsonc语法的注释。要使其正常工作,你需要让 VS Code 将您的 JSON 文件视为jsonc文件:

  1. 打开您的设置并搜索files.associations
  2. 添加自定义关联,将.json视为jsonc
"files.associations": {
    "*.json": "jsonc"
}

这将允许您在 JSON 文件中添加注释并防止//注释出现红色突出显示。

例子:

{
    // This is a comment
    "security.workspace.trust.untrustedFiles": "open",
    "workbench.editor.untitled.hint": "hidden",
    "editor.largeFileOptimizations": false,
    "cmake.configureOnOpen": true,
    "github.copilot.enable": {
        "*": true,
        "plaintext": false,
        "markdown": false,
        "scminput": false
    },
    "JSON-zain.json.autorefresh": true,
    "[json]": {
        "editor.quickSuggestions": {
            "strings": true
        },
        "editor.suggest.insertMode": "replace"
    },
    "json.schemas": []
}

这将允许您的//注释正常工作而不会显示红色突出显示。