🗒️json文件添加注释
2024-9-12
| 2024-10-10
0  |  阅读时长 0 分钟
date
Sep 12, 2024 03:08 AM
type
status
slug
summary
tags
category
updated
Oct 10, 2024 08:05 AM
icon
password
在 VS Code 中,JSON 文件默认不支持注释,这确实会让配置文件的阅读和维护变得困难。不过,你可以通过以下步骤将 JSON 文件设置为支持注释的格式,从而提高可读性。

配置 JSON 文件以支持注释

  • 打开 VS Code 左下角的设置图标 → 选择设置
  • 在设置页面中搜索文件关联
  • 找到 Files: Associations 配置项,并在其中新增以下项目:
    • 项:文件名.json
    • 值:jsonc

注意事项

  • 仅适用于本地 VS Code:上述配置仅对你本地的 VS Code 环境有效。如果你在共享项目中使用这种配置,确保其他开发者也了解这个设置,否则他们可能会看到格式错误。
  • 注意文件兼容性:虽然 jsonc 可以让你在文件中添加注释,但在实际部署或传输 JSON 文件时,请确保这些注释不会被包含进去,因为标准的 JSON 格式不支持注释。
这样,你就可以在 JSON 文件中愉快地添加注释了,有助于提升配置文件的可读性和维护性。
 
  • 工具
  • uniapp 基础框架整理Vue3 完美实现权限管理
    Loading...