推荐VSCODE插件:为`package.json`添加注释信息

2024-01-10 06:14:59

众所周知,JSON文件是不支持注释的,除了JSON5/JSONC之外,我们在开发项目特别是前端项目时,大量会用到JSON文件,特别是在编写package.json中的scripts时,由于缺少注释,当有大量的命令脚本时,就有了添加注释的需求。

因此就有了JsonComments这个Vscode扩展插件,可以为工程中的任意Json文件增加注释功能。启用JsonComments插件的效果如下:

1701175468111.png

安装插件

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": ""                
}

推荐

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

文章来源:https://blog.csdn.net/wenxuansoft/article/details/135486736
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。