VSCode的Code Spell Checker插件:告别代码中的拼写错误

10次阅读

vscode 的 Code Spell Checker 插件可实时识别并高亮拼写错误,需依次安装插件、配置中英文语言支持、设置忽略词、限定检查范围,并利用内联建议快速修正。

如果您在编写代码时频繁遇到变量名、注释或字符串中的拼写错误,vscode 的 code spell checker 插件可实时识别并高亮这些错误。以下是启用与配置该插件的具体操作步骤:

本文运行环境:macBook air,macOS Sequoia。

一、安装 Code Spell Checker 插件

该插件需通过 VSCode 扩展市场获取并安装,是所有后续功能的基础前提。

1、打开 VSCode,点击左侧活动栏最下方的扩展图标(四个方块组成的图标)。

2、在扩展搜索框中输入 Code Spell Checker

3、在搜索结果中找到作者为 Street Side Software 的插件,点击“安装”按钮。

4、安装完成后点击“重新加载”使插件生效。

二、启用拼写检查并设置语言

插件默认仅对英文文本启用检查,需手动添加项目常用语言词典以覆盖中文注释、多语言字符串等场景。

1、按下 Cmd + ,macos)打开设置界面。

2、在搜索框中输入 cSpell.language

3、点击“在 settings.json 中编辑”,在数组中添加 “zh”“en”,例如:“cSpell.language”: [“en”, “zh”]

4、保存文件后,插件将同时校验中英文拼写。

三、忽略特定单词或代码段

为避免将合法的专有名词、缩写或技术术语误标为错误,可通过配置文件将其加入忽略列表。

1、在项目根目录下创建文件 cspell.json(若不存在)。

2、在该文件中添加 words” 字段,并填入需保留的单词,例如:words”: [“react”, “API”, “URL”]

3、确保 cSpell.enabled 设置为 true,且 cSpell.allowCompoundWords 设为 true 以支持驼峰命名识别。

四、自定义拼写检查范围

插件默认检查注释、字符串和普通文本,但可通过配置排除非必要区域,减少干扰提示。

1、打开 settings.json 文件。

2、添加 “cSpell.wordsOnlyCheckInCommentsAndStrings” 并设为 true,限制检查范围仅限注释与字符串。

3、如需进一步排除某类文件,添加 “cSpell.ignorePaths”,例如:[“node_modules/**”, “**/dist/**”]

五、快速修正拼写错误

当插件检测到拼写问题时,可通过内联建议快速替换为正确拼写,无需手动输入。

1、将光标悬停在带波浪线的错误单词上。

2、点击出现的灯泡图标或按下 Cmd + . 调出建议菜单。

3、从下拉列表中选择推荐的正确拼写,按回车确认替换。

4、若建议不匹配,可选择“添加到用户词典”将该词永久加入白名单。

text=ZqhQzanResources