Code Spell Checker插件可自动检查代码中注释、字符串及标识符的拼写错误,支持多语言和驼峰命名识别。安装后通过右键添加词汇至工作区或用户词典,并可用.cspell.json配置自定义词、排除路径等,提升代码质量。

vscode 的 Code Spell Checker 是一款非常实用的插件,能帮助开发者在编写代码时检查变量名、注释、字符串中的拼写错误。它支持多种语言,自动识别驼峰命名、下划线命名等常见命名方式,不会将合法的代码结构误判为拼写错误。
安装 Code Spell Checker 插件
打开 VSCode,进入扩展面板(快捷键 Ctrl+Shift+X),搜索 Code Spell Checker,选择由 streetsidesoftware 发布的版本,点击“安装”。
基本使用方法
安装完成后,插件会自动对以下内容进行拼写检查:
发现拼写错误时,错误单词下方会出现红色波浪线。右键点击该单词,会弹出建议修正项,可选择“更改为此”来快速替换。
添加自定义词汇
项目中常会用到专业术语或人名、地名等非字典词汇。可以通过以下方式添加到忽略列表或用户词典:
- 右键点击标红单词,选择“添加到工作区词典”或“添加到用户词典”
- “工作区词典”仅对当前项目生效,词汇会写入项目根目录下的
.cspell.json文件 - “用户词典”全局生效,适合常用技术词汇如
react、typescript等
配置 .cspell.json 文件
在项目根目录创建 .cspell.json 文件,可以精细化控制拼写检查行为:
{ “version”: “0.2”, “language”: “en”, “allowCompoundwords”: true, “words”: [ “vue“, “eslint”, “webpack” ], “ignorePaths”: [ “node_modules”, “**/*.min.js”, “dist” ] }
这个配置指定了语言、允许复合词、添加了自定义词汇,并排除了不需要检查的路径。
基本上就这些。启用后几乎无需干预,能有效提升代码可读性和文档质量。