作为程序员都应该知道无论用任意语言开发任何程序,编写的代码不仅仅能够让机器正常编译,更重要的是自己或者团队其他开发者能够读懂代码的含义。
因此作为一名合格的iOS程序员,应该懂得一些常用的Cocoa框架编码规范,Apple开发者中心提供一套权威的编码规范:Introduction to Coding Guidelines for Cocoa
基于Apple提供的编码规范文档,我从中翻译并整理一些较为常用的Cocoa编码规范。
本文主要涉及Cocoa编码规范文档中“基本命名规则”部分。
基本命名规则
1. 一般原则
代码越简洁明了越好,但是我们不能为了简洁,而导致语义不清晰:
代码 | 代码评价 |
---|---|
insertObject:atIndex: | 不错 |
insert:at: | 不明确,什么被插入了?at指的是什么? |
removeObjectAtIndex: | 不错 |
removeObject: | 不错 |
remove: | 不明确,移除了什么? |
一般情况下,有时对象名称很长,最好不要进行缩写,而是采用全拼的名称:
代码 | 代码评价 |
---|---|
destinationSelection | 不错 |
destSel | 不明确 |
setBackgroundColor: | 不错 |
setBkgdColor: | 不明确 |
你可能认为有些缩写是众说周知的,但这种情况并不绝对,尤其是当开发者和你身处的文化背景不一样时,这些缩写就很有可能产生歧义。
当然,部分缩写已经成为了公知了,你可以继续使用它们,请参考:Acceptable Abbreviations and Acronyms
避免有歧义的API命名,例如,方法名包含多个含义:
代码 | 代码评价 |
---|---|
sendPort | 是发送端口还是返回端口? |
displayName | 显示一个名字还是返回用户界面中消息接收者需要的标题? |
当开发者拥有一个实现多态方法的类,保持类接口命名一致性非常重要。例如:不同类中处理同一个任务的方法命名应该是一致的。
代码 | 代码评价 |
---|---|
- (NSInteger)tag | 在 NSView, NSCell, NSControl类中都要定义 |
2. 前缀
前缀在编程接口中非常重要。一个软件拥有不同的功能模块,通常它们封装在一个框架或者紧密相关的框架中。前缀避免了第三方开发者与苹果提供的框架间的命名冲突问题。
前缀是有规定格式的,通常由2或3个大写字母组成,而不是下划线或者“子前缀”。例如:
前缀 | Cocoa 框架 |
---|---|
NS | Foundation |
NS | Application Kit |
AB | Address Book |
IB | Interface Builder |
通常使用前缀命名类、协议、函数、常数、自定义结构体,但是不要使用前缀来命名方法。
3. 书写规则
对于由多个单词组成的名字,不要使用标点符号作为名称的一部分或者分割符,例如:下划线、破折号等。
最好使用“骆驼”风格的命名规则,例如:runTheWordsTogether。
有几点需要注意一下:
- 对于方法名称,首字母小写,不要使用前缀,
例如:fileExistsAtPath:isDirectory:
但是有一种例外情况,就是方法名称已通用的缩写开头,
例如:TIFFRepresentation (NSImage) - 对于函数和常数,使用和类相同的前缀,并且前缀后第一个单词大写。
例如:NSRunAlertPanel 和 NSCellDisabled
避免在方法名前加下划线来表示私有方法(在实例变量名称前加下划线是被允许的),第三方开发者使用可能导致命名冲突。
4. 类和协议命名
类名应该包含一个名词,能够清晰地表达类(或类对象)作用或者含义。
类应该有一个合适的前缀名。
例如:NSString, NSDate, NSScanner, NSApplication, UIApplication, NSButton, 和 UIButton
协议的命名应该根据使用协议的相应类行为进行命名。
- 大多数协议包含的方法,与任何特定类都是无关的。为了让协议命名不与类相互混淆,通常的规则是:使用动名词(...ing)形式:
| 代码| 评价|
| :-|:-|
| NSLocking| 不错
| NSLock| 不太好,看起来像类名
- 有些协议包含了一些无关方法(而不是创建多个独立的小协议)。这些协议与某个类的关联紧密,这个类是该协议的一种体现。在这种情况下,协议名称就应该和类名称保持一致。
例如:NSObject协议,该协议包含一些方法可以查询任意类在父类中的层次位置。由于NSObject类实现了协议的大部分方法,所以协议就用类名进行命名了。
网友评论