iOS之深入解析Xcode的拼写检查

Posted 2021-12-28 Forever_wj

一、引言

• 作为一名开发人员，当编写代码时，我们会更多地关注逻辑和算法，而不是拼写和语法。但它也是我们编码的一个重要部分，特别是当从注释生成文档的时候。
• 拼写检查帮助我们找出拼写错误，让我们有更多的时间关注代码逻辑。

二、拼写检查能识别什么？

• 答案就是代码中与 Spelling and Grammer 相关的所有内容：
• • 变量名
• • 方法
• • 类
• • 注释
• • 字符串的字面量（包括本地化）
• 现有如下一段代码：

enum CompanTyp: String 
	case `public` = "PublicCompanies"
	case `private` = "PrivateCompanies"
	case unicorn = "UnicornCompanies"
	case associated = "AssociateCompanies"

class Company 
	// Cmpany Id
	var companyId: String
	// Company Name
	var companyName: String 
	// Company Type
	var companyTypa: CompanTyp
	// number of employee in company
	var numberOfEmplayee: Int = 0
	init(companyId: String, companyName: String, companyType: CompanTyp) 
		self.companyId = companyId
		self.companyName = companyName
		self.companyTypa = companyType
	
	func addNewEmployea() 
		numberOfEmplayee = numberOfEmplayee + 1
	
	func getEmplayeeCount() -> Int 
		return numberOfEmplayee
	

• 在上面的代码中，包括类、方法、变量和注释，但没有启用Spelling and Grammer。猛一看去，好像没啥问题，但如果我们仔细检查，就会发现很多拼写错误。
• 现在让我们启用 Spelling and Grammer，看看会发生什么?

enum CompanTyp: String 
	case `public` = "PublicCompanies"
	case `private` = "PrivateCompanies"
	case unicorn = "UnicornC ompanies"
	case associated = "AssociateCompanies"

class Company 
    // Cmpany Id
    var companyId: String
    // Company Name
    var companyName: String
    // Company Type
    var companyTypa: CompanyTypa
    // number of employee in company
    var numberOfEmplayee: Int = 0
    init(companyId: String, companyName: String, companyType: CompanTyp) 
        self.companyId = companyId
        self.companyName = companyName
        self.companyTypa = companyType
    
    func addNewEmployea() 
        numberOfEmplayee = numberOfEmplayee + 1
    
    func getEmplayeeCount() -> Int 
        return numberOfEmplayee
    

• 在上面的代码中我们可以看到，当我们启用拼写检查时，它能检测到所有的拼写错误，并用红色高亮显示。现在就省去了找错误的时间，可以直接去修改。

三、如何开启？

• 如下所示，Edit -> Format -> Spelling and Grammar：

① Check Spelling While Typing

• 启用后，会把项目中的所有输入错误一次性、全部以红色高亮显示，就像上面的例子一样。
• 另外，开启这个选项后，还可以选中要修改的单词，然后右键，菜单中会出现 Xcode 建议的单词：

② Check Document Now

• 它将在当前文件中逐个显示输入错误。为了检查当前文件中的所有错误，可以重复这个命令Edit -> Format -> Spelling and Grammar -> Check Document Now，或者使用快捷键 command 和分号（;）的组合

③ Show Spelling and Grammar

• 它会打开所有建议的更改，可以单击其中任何一个进行替换。使用命令Edit -> Format -> Spelling and Grammar -> Show Spelling and Grammar，或者使用快捷键 command 和冒号（:）的组合：

④ Learn Spelling 和 Ignore Spelling

• 有时候我们需要使用一些在系统词典中没有定义的独特词汇，比如应用程序前缀、开发者名称、公司名称等。Xcode 也会检查这些单词的错误。
• 所以就用 Learn Spelling 或者 Ignore Spelling 处理这些特殊的单词：

四、通过菜单

• 右键选中要处理的单词：

• 通过 command + ：