iOS:编码规范-基本命名规则

作为程序员都应该知道无论用任意语言开发任何程序,编写的代码不仅仅能够让机器正常编译,更重要的是自己或者团队其他开发者能够读懂代码的含义。

因此作为一名合格的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类实现了协议的大部分方法,所以协议就用类名进行命名了。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,324评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,303评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,192评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,555评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,569评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,566评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,927评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,583评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,827评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,365评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,941评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2 342

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,580评论 18 139
  • 开发cocoa框架、插件或者其它带公共API的可执行文件需要不同于应用开发一些方法和惯例。你的产品的主要客户是开发...
    酱油不爱醋阅读 1,628评论 0 4
  • 苹果官方文档翻译 《Objective-C语言编程》(Programming with Objective-C) ...
    fever105阅读 25,578评论 19 130
  • 翻译自“Coding Guidelines for Cocoa” 0 简介 使用公开的API开发一个Cocoa框架...
    lakerszhy阅读 1,077评论 0 6
  • 今天是正月15下午我一个人在走廊上晒太阳,听歌,刷手机。我喜欢坐在走廊的角落里,那里晒得到太阳却吹不到风,有一种被...
    guliyan阅读 144评论 0 0