跳到主要内容
uencoder

JSONC

JSONC(JSON with Comments)是允许注释的 JSON 变体,主要用于 VS Code 配置(tsconfig、settings.json)。

用途

在 JSON 中允许注释,使配置文件可加说明,提升可维护性。

机制

在 JSON 基础上允许 // 单行注释与 /* */ 多行注释,其余语法同 JSON。VS Code 与 TypeScript 编译器支持。部分实现还允许尾逗号。

用例

  • VS Code settings.json 编辑器配置
  • tsconfig.json 配置
  • ESLint 配置
  • IDE 配置文件

示例

  • 输入
    {// comment
    "a":1}
    输出
    The object {a:1}

    Comments are allowed

常见错误

A standard JSON parser fails on JSONC
Use a comment-aware parser such as jsonc-parser

相关词条

相关工具

参考链接