众所周知,JSON
文件是不支持注释的,除了JSON5/JSONC
之外,我们在开发项目特别是前端项目时,大量会用到JSON
文件,特别是在编写package.json
中的scripts
时,由于缺少注释,当有大量的命令脚本时,就有了添加注释的需求。
因此就有了JsonComments
这个Vscode
扩展插件,可以为工程中的任意Json
文件增加注释功能。启用JsonComments
插件的效果如下:
安装插件
在Vscode
扩展中搜索JsonComments
,然后安装该插件即可。
使用方法
- 添加注释
打开当前工作区任意JSON
文件,在任意键上悬停,在悬停提示中点击Add Comment
,即可输入并添加注释。
添加的注释将以CodeLens
的形式显示在所注释的键上方。
- 删除注释
直接点击注释内容,选择删除注释
即可。
- 清空注释
按下Ctrl+Shift+P
,输入Clear All Comments
,即可清空当前文档的所有注释。
问题
- 注释内容保存在哪里?
默认情况下,注释内容保存在当前工作区的package.json
文件中的json-comments
中。
如果你想要修改保存位置,可以工作区配置中进行修改。
- 如何更改注释保存位置?
修改工作区配置JsonComments
中的Save File
和Entry Key
即可。
例如:
// 保存在当前工作区的comments.json文件中
"json-comments": {
"Save File": "comments.json",
"Entry Key": ""
}
推荐
VoerkaI18n - Internationalization solution for ‘Javascript/Typescript/Vue/React/Solidjs/SvelteJs/ReactNative’