Sublime Text 中 JSON 注释支持的配置方式

大枫同学_1718

大枫同学_1718

2026-11-07

436人浏览

原创

Sublime Text原生不支持JSON注释,因RFC 8259标准禁止注释且JSON语法未定义comment规则;唯一安全方案是切换为JSONC语法并配合SublimeLinter-jsonc插件,否则Ctrl+/无效或引发解析错误。

sublime text 中 json 注释支持的配置方式

Sublime Text 原生不支持 JSON 注释,强行加 // 或 /* */ 会导致解析失败;唯一安全方案是切换到 JSONC 语法并配对插件,否则所有“注释”都是假象。

为什么 Ctrl+/ 在 .json 文件里加不了注释

JSON 标准(RFC 8259)明确禁止注释,Sublime 的 JSON 语法定义里根本没写 comment_line_start 或 comment_block_start 规则。右下角显示 JSON 时按 Ctrl+/,要么没反应,要么乱插符号(比如在行首加 #),这不是快捷键坏了,是语法根本不认。

常见错误现象:

  • 按 Ctrl+/ 后出现 # 或 //,但保存后 JSON 解析器报错
  • 文件右下角显示 Plain Text 或 JavaScript,误以为“能注释”其实是语法识别错了
  • 装了 Pretty JSON 或 JsFormat,结果把 null 转成字符串、删掉反斜杠,污染原始数据

用 JSONC 语法 + SublimeLinter-jsonc 实现真注释

JSONC(JSON with Comments)是 VS Code 等工具广泛采用的非标但实用的扩展格式,Sublime 需靠插件支持。关键不是“让 JSON 支持注释”,而是“告诉 Sublime:这文件是 JSONC,按另一套规则处理”。

操作步骤:

  • 安装 SublimeLinter-jsonc 插件(不是 SublimeLinter-json):按 Ctrl+Shift+P → Package Control: Install Package → 搜 SublimeLinter-jsonc
  • 手动切换语法:点击右下角状态栏 → Set Syntax: JSONC(若没有该选项,需先安装 JSONC 语法包,如 JSONC Syntax)
  • 确保校验生效:在 Preferences → Package Settings → SublimeLinter → Settings 用户配置中加入:
    {
      "linters": {
        "jsonc": {
          "selector": "source.jsonc"
        }
      }
    }

此时 Ctrl+/ 才会正确插入 // 行注释,且 SublimeLinter-jsonc 能识别并忽略它们——这才是带注释的合法工作流。

Expanso yaml-to-json
Expanso yaml-to-json

使用 Expanso Edge 管道将 YAML 输入转换为 JSON 格式。

下载

JSONC 文件的格式化与保存风险

即使启用了 JSONC 语法,原生 JSON Reindent 和多数格式化插件仍会把它当普通 JSON 处理,删注释、改引号、加尾随逗号,导致注释丢失或结构破坏。

安全做法:

  • 别用 JSON Reindent 处理 .jsonc 文件——它不识别注释,会直接删掉整行
  • HTML-CSS-JS Prettify 可以支持 JSONC,但必须在设置中显式开启:
    "json": true,
    "jsonc": true
    (注意:部分旧版插件无 jsonc 开关,需升级)
  • 保存前务必确认右下角是 JSONC,不是 JSON——两者 scope 不同,插件行为完全隔离
  • 如果项目要交付给其他系统(如后端 API),注释必须人工删除或用脚本清理,不能依赖编辑器自动剥离

临时注释的保底方案:切语法 + 列模式

当 JSONC 不可用、插件冲突、或只是一次性调试,最稳的方式是绕过语法限制:

  • 先按 Ctrl+Shift+P → 输入 Set Syntax: JavaScript,让 Ctrl+/ 生效(JS 支持 //)
  • 选中要注释的多行,按住 Alt(Win/Linux)或 Option(macOS),鼠标从第一行开头拖到最后一行目标列位置,松开后在每行相同列插入 //
  • 完成后记得切回 JSON 或 JSONC 语法,避免误保存为 JS 文件

这个方法不依赖任何插件,也不修改语法定义,但需要你手动控制注释位置——容易漏行或错位,仅适合紧急场景。

真正麻烦的从来不是“怎么加注释”,而是“加完之后谁来保证它不被格式化工具吃掉、不被校验器报错、不被下游系统拒绝”。JSONC 是目前最平衡的选择,但得全程盯住语法标识和插件开关,漏一个环节,注释就变成 bug 温床。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

2023.06.20

4816

8

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.07.28

1435

5

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.03

1878

5

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

2023.08.17

10363

11

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

1020

4

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

3024

5

Js中concat和push的区别
Js中concat和push的区别

Js中concat和push的区别:1、concat用于将两个或多个数组合并成一个新数组,并返回这个新数组,而push用于向数组的末尾添加一个或多个元素,并返回修改后的数组的新长度;2、concat不会修改原始数组,是创建新的数组,而push会修改原数组,将新元素添加到原数组的末尾等等。本专题为大家提供concat和push相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.14

1649

5

js截取字符串的方法介绍
js截取字符串的方法介绍

JavaScript字符串截取方法,包括substring、slice、substr、charAt和split方法。这些方法可以根据具体需求,灵活地截取字符串的不同部分。在实际开发中,根据具体情况选择合适的方法进行字符串截取,能够提高代码的效率和可读性 。

2023.09.21

5229

3

js生成随机数方法
js生成随机数方法

JavaScript生成随机数的方法,包括使用Math.random()方法生成指定范围内的随机整数、生成随机字符串和生成随机颜色。根据具体需求,可以选择适合的方法来生成随机数,以实现各种功能 。

2023.09.25

3055

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程