Sublime怎么在JSON配置中添加注释说明

陌浩大大_4952

陌浩大大_4952

2026-11-05

672人浏览

原创

Sublime 的 JSON 配置文件原生不支持注释,因 JSON 标准(RFC 8259)明确禁止;可行替代是用 "_comment" 等字符串键模拟注释,或拆分配置+外部 README 说明。

sublime怎么在json配置中添加注释说明

Sublime 的 JSON 配置文件(如 Preferences.sublime-settings、Key Bindings.sublime-keymap)**原生不支持注释**——只要写入 // 或 /* */,保存后 Sublime 就会报错:Expected value in JSON,并拒绝加载该配置。

为什么 JSON 配置里不能加注释

JSON 标准(RFC 8259)明确禁止注释。Sublime 的解析器严格遵循这一规范,不是“没实现”,而是“不能实现”。哪怕只多一个 //,整个文件就不再是合法 JSON,Sublime 会直接忽略或崩溃加载。

替代方案:用字符串字段模拟注释

实际可行且被广泛采用的做法,是把说明文字放在一个**合法的字符串键值对中**,键名用下划线开头(如 "_comment" 或 "_note"),确保它不会干扰功能逻辑:

cn-json-diff
cn-json-diff

比较两个 JSON 文件并显示差异。支持嵌套结构、数组及值变更。纯 Python 标准库实现,无需 API 密钥。

下载
{
  "_comment": "以下为自定义快捷键:Ctrl+Alt+L 用于格式化当前文件",
  "keys": ["ctrl+alt+l"],
  "command": "reindent"
}
  • Sublime 完全接受这种写法,不会报错,也不会影响功能执行
  • 所有以 _ 开头的键名在社区约定中视为“元信息”,插件和用户都默认忽略
  • 注意:不要用 // 包裹这行,"_comment" 本身是字符串值,不是语法注释

更安全的实践:拆分配置 + 外部 README

如果你的配置越来越复杂(比如大量自定义 key binding 或 syntax-specific 设置),硬塞注释字符串容易混乱。推荐:

  • 把主配置文件保持“纯功能”,不加任何 _comment
  • 另建一个 README.md 或 notes.txt 放在 Packages/User/ 目录下,逐条解释每项配置的作用和修改原因
  • 用 Sublime 的 Package Control: List Packages 和 Preferences: Settings – Syntax Specific 等命令定位真实生效路径,避免改错文件

真正容易被忽略的是:很多人以为把注释写在 JSON 文件末尾、用换行隔开就“没事”,但只要解析器读到非法字符,就会截断——哪怕只差一个空格,reindent 键绑定也可能突然失效。宁可多开一个文本文件写说明,也别碰 JSON 的语法边界。

相关文章

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

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

下载

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

相关专题

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

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

2023.06.20

4756

8

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

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

2023.07.28

1415

5

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

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

2023.08.03

1858

5

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

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

2023.08.17

10303

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

3004

5

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

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

2023.09.14

1629

5

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

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

2023.09.21

5149

3

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

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

2023.09.25

3015

5

热门下载

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

精品课程

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