vscode json文件注释

### 如何在VSCode中对JSON文件添加注释

通常情况下，标准的 JSON 文件不支持注释。然而，在开发环境中有时确实有需求为配置文件或其他类型的 JSON 数据添加注释来提高可读性和维护性。对于这种情况，可以借助特定工具或库实现带注释功能的支持。

为了能够在 VSCode 中处理带有注释的 JSON 文件，推荐使用 `comment-json` 这样的 npm 包[^1]。此包允许解析并序列化包含注释的 JSON 文档，并且可以在保存之后仍然保留这些注释不变。

安装该插件后，可以通过以下方式操作：

#### 安装 comment-json 插件
如果项目基于 Node.js 或者 JavaScript 构建，则可以直接通过命令行安装依赖项：

npm install comment-json --save-dev

#### 使用方法示例
下面是一个简单的例子展示如何利用这个模块加载和写入含备注的信息到 json 文件里去。

const cjson = require('comment-json');
// 读取含有注释的 JSON 文件
let obj = cjson.parse(`{
    "name": "example", // This is an example field.
    "version": "0.0.1"
}`);
console.log(obj);

// 将对象转回成字符串形式的同时保持原有注解
let str = cjson.stringify({
    name: 'example',
    version: '0.0.1'
}, null, 4);
console.log(str);

值得注意的是，虽然上述解决方案适用于某些场景下的开发流程优化，但在实际部署前应当移除所有的注释以确保最终使用的 JSON 符合规范要求。

另外一种做法是在编辑器层面寻找支持 JSONC (即扩展名为 .jsonc 的文件)，它本质上就是普通的 JSON 加上了 C 风格的单行或多行注释语法特性。VS Code 默认就提供了对 `.jsonc` 文件格式的良好支持，因此只需简单更改文件名即可享受这项便利的功能而无需额外配置任何东西。