Skip to content

Latest commit

 

History

History
78 lines (42 loc) · 2.31 KB

README_CN.md

File metadata and controls

78 lines (42 loc) · 2.31 KB

json-comments

中文 | English

为任意JSON文件添加自定义注释,效果如下:

安装

打开VSCode扩展,搜索JsonComments,然后安装即可。

链接

使用方法

  • 添加注释

打开当前工作区任意JSON文件,在任意键上悬停,在悬停提示中点击Add Comment,即可输入并添加注释。 添加的注释将以CodeLens的形式显示在所注释的键上方。

  • 删除注释

直接点击注释内容,选择删除注释即可。

  • 清空注释

按下Ctrl+Shift+P,输入Clear All Comments,即可清空当前文档的所有注释。

问题

  • 注释内容保存在哪里?

默认情况下,注释内容保存在当前工作区的package.json文件中的json-comments中。 如果你想要修改保存位置,可以工作区配置中进行修改。

  • 如何更改注释保存位置?

修改工作区配置JsonComments中的Save FileEntry Key即可。 例如:

// 保存在当前工作区的comments.json文件中
"json-comments": {
    "Save File": "comments.json",
    "Entry Key": ""                
}
  • 注释会修改原始的JSON文件吗?

不会,所有的注释默认均保存在package.json文件中的中。

  • 注释提交到到Git后会丢失吗?

不会,只要你将保存注释的文件一起提交即可。

  • 开发团队中其他人可以看到注释吗?

可以,只需要安装JsonComments插件即可。

  • 当JSON文件编辑后注释内容会丢失吗?

只要所注释的键的jsonpath路径没有变化就不会丢失。JsonComments是以jsonpath路径为键来保存注释内容的。

  • 当移动JSON文件时会导致注释丢失吗?

不会,插件会侦听文件移动来自动更新注释信息。但是如果你脱离了VSCode环境移动或更名了文件,那么注释关联信息就会丢失。此时你可以手动修改package.json文件中的json-comments中的路径即可。

推荐

VoerkaI18n - Internationalization solution for 'Javascript/Typescript/Vue/React/Solidjs/SvelteJs/ReactNative'