#打卡不停更# 软件开发中好用的拼写检查工具原创

zhushangyuan_

发布于 2022-10-20 11:44

浏览

0收藏

软件开发中好用的拼写检查工具

程序员在编写代码的过程中，容易出现英文单词拼写错误。拼写错误这样的小错误也不可能忽视，错误无论大小，都会给开发者体验带来不同程度的负面影响。我们每个人都应该树立零缺陷这样的质量意识。越是低级的问题，越是会让客户不放心。如果错别字比比皆是，如何让客户相信不存在大的问题呢。本文推荐一些软件开发中好用的拼写检查工具。

1、 VSCode插件 Code Spell Checker

VSCode是一个非常通用的IDE，支持非常丰富的扩展插件。打开VSCode的扩展，搜索spell，可用的扩展插件就可以搜索出来，推荐安装Code Spell Checker。安装后的效果截图如下：

#打卡不停更# 软件开发中好用的拼写检查工具-鸿蒙开发者社区

1.1 如何识别拼写错误

使用起来非常简单，当识别到错别字的时候，会以下波浪线呈现出来。如下图所示，这是docs文档仓的一个实际例子，第7行startAbilty的拼写是错误的，正确的应该是startAbility，少了个i。如果不安装拼写检查扩展插件，是识别不出来的。

#打卡不停更# 软件开发中好用的拼写检查工具-鸿蒙开发者社区

这个扩展插件，只能识别打开的文件，如果文件没有打开，是无法识别到的。另外，也会误识别，比如Issue ID，是随机的数字，Code Spell Checker会识别为错误拼写。其他的术语类的，也可能会被误识别。只能帮助把所有的识别出来，然后工程师再检查确认下，是否真正的拼写错误。

1.2 一些拼写检查操作

如果有些术语误识别，比如OHOS，量比较大，我们可以添加到设置里，让拼写检查工具不再识别为错误拼写。可以这样操作，右键点击识别错误的单词，选择Spelling–Add words to Workspace/User Settings，分别为工作区和用户级别的设置。通常建议添加到用户级别的设置里即可。

另外，对于单词拼写，也提供了正确拼写建议。右键点击识别错误的单词，选择Spelling Suggestion即可，会显示一些建议的单词，根据实际情况选用。

2、命令行工具CSpell

由于VSCode的拼写检查扩展插件，只能识别打开文件中的拼写错误，需要一一打开文件，适合开发过程中使用。如果想批量检查拼写错误，也可以使用命令行工具CSpell，可以对所有的文件进行快速检查。每个工程师都有些缩写，或者项目的术语，也会有误报，需要工程师一一识别，是否需要针对识别出来的问题进行修改。

2.1 工具安装

该命令行工具使用NodeJS开发，需要先安装NodeJS，然后执行命令npm i cspell即可完成命令行工具的安装。

2.2 使用示例

可以使用如下命令，把拼写检查错误输出到指定的目录里。

cspell -c ~/cspell.json  "**" > ~/spell_output.txt

配置文件中cspell.json可以定义一些需要忽略的单词，识别如下：

{

	"version": "0.2",

	"language": "en",

	"words": [
		"mkdirp",
		"tsmerge",
		"githubusercontent",
		"streetsidesoftware",
		"vsmarketplacebadge",
		"visualstudio", "Napi", "OHOS", "GTEST", "HWTEST", "HILOG", "Parcelable", "dataability", "sptr", "libhilog", "hiviewdfx", "innerkits", "huks", "appdatafwk", "testonly", "samgr", "IFILE", "systemability", "hvigor", "nocheck", "datashare", "oper", "fileoper", "Gitee", "zuri", "samgr", "NARG", "openharmony", "myhuaweicloud", "backports", "nullptr", "typeof", "struct", "cout", "googletest", "googlemock", "FILEACCESS", "checkpermission", "cflags", "medialibrary", "abilitykit", "aafwk", "DBINDER", "arkui", "filemgmt", "nullptr", "libn", "policyitems", "licensefile", "tasklist", "filefilterlist", "oatconfig", "Hmdfs", "fuzzer", "fuzztest", "filemanagement", "remotefileshare", "distributedfiles",
		"policylist", "projectroot", "filefilter", "policyitem", "syscap", "safwk", "liteos", "openharmony", "posix", "hctest", "Hispark", "Hiview", "hitrace",
		"LOGI", "LOGD", "LOGW", "LOGE", "subsys", "XCOLLIE", "hisilicon", "ipcamera", "wifiiot", "cplusplus", "ifdef", "ldflags", "helloworld", "sourcecode", "quickstart", "hitool",
		"subsys", "cmsis", "cppsupport", "LOSCFG", "Gpio", "cmake", "Wlan", "licensetext", "creativecommons", "sublicensable",
		"filteritem", "uvwxyz", "licensematcherlist", "licensematcher", "Zulip", "rawfile", "webgl", "Tencent", "Destory", "LWIP", "coap", "cjson", "JTAG", "Nend", "Bais",
		"doxygen", "scons", "classname", "jstest", "wakeup", "Geolocation", "xdevice", "testcase", "libc", "wmserver", "hotspot", "Deque",
		"DONOT", "histreaming", "Oled", "iothardware", "udelay", "ssid", "riscv", "hisi", "baudrate", "commonlibrary", "uart", "wechat", "libcoap",
		"Rosen", "nweb", "WVLOG", "libnweb", "zhangsan", "libz", "gmock", "libnweb", "realme",
		"mbedtls", "hihope", "softbus", "appspawn", "bytrace", "hiperf", "thirdparty", "securec", "emmc", "osal", "ifeq", "ifneq",
		"histreamer"
	],
	"flagWords": [
		"hte"
	]
}

详细的用法可以阅读参考资料部分。