iOS 使用清晰而协调的命名方式

类、方法及变量的命名是Objective-C编程的重要环节。通常会觉得OC的语言很繁琐,因为其语法结构使代码读起来和句子一样。

NSString *text = @"The quick brown fox jumped over the lazy dog.";
NSString *newText =  [text stringByReplacingOccurrencesOfString:@"cat" withString:@"fox"];

此段代码看起来比较繁琐,但是准确的表达了开发者想做的事。在命名不像OC这般复杂的语言中,类似的程序可能会这样写

string text = @"The quick brown fox jumped over the lazy dog.";
string newText =  text.replace("cat", @"fox");

这样写虽然简单,但是可能会疑惑:这两个参数是如何解读呢?是fox替换cat,还是cat替换fox;还有一个疑问:replace这个函数是把text里出现的所有fox都替换,还是只替换出现的第一个?其名称没有清楚地表达出这些意思。而OC的命名方式虽然长了一点,但是却非常清晰。

方法与变量名使用了“驼峰命名”,以小写字母开头,其后每个单词首字母大写。类名也用驼峰命名发,不过其首字母需要大些。
关于驼峰命名法,我推荐《禅与 Objective-C 编程艺术》

随说使用长名字可以使代码更易读,也应该尽量言简意赅。
NSString类展示了一套良好的命名习惯。
+string
工厂方法,用于创建新的空字符串
+stringWithString
工厂方法,根据某字符串创建出与之内容相同的新字符串。
+localizedStringWithFormat
工厂方法,根据特定格式创建出新的“本地化字符串”。
等等。。。
使用方法命名时,注意几条规则:
1.如果方法的返回值是新创建的,那么方法名的首个词应是返回值类型,除非前面还有修饰语,例如localizedString。属性的存取方法不遵循这种命名方式,因为一般认为这些方法不会创建新的对象,即便有时返回内部对象的一份拷贝,我们也认为那相当于原有的对象。
2.应该把表示参数类型的名词放在参数前面。
3.如果方法要在当前对象上执行操作,那么就应该包含动词;若执行操作时还需要参数,就在动词后面加上一个或多个名词。
4.不要使用str这种简称
5.Boolean属性应该加is前缀。如果某方法返回非属性的Boolean值,那么应该根据其功能,选用has或is前缀。
6.由“输入输出”来保存返回值的方法用get前缀。

类与协议的命名
命名方式应该协调一致。如果从其他框架中继承子类,那么务必遵循其命名惯例,例如,继承自UIView的自定义子类,那么累名末尾的词必须是view

总结:
1.起名时应遵从标准的Objective-C命名规范,这样创建出来的接口更容易为开发者所理解。
2.方法名要言简意赅。
3.方法名里不要使用缩略后的类型名称。

读Effective Objective-C 2.0 有感

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

推荐阅读更多精彩内容

  • 苹果官方文档翻译 《Objective-C语言编程》(Programming with Objective-C) ...
    fever105阅读 25,530评论 19 130
  • iOS编程规范0规范 0.1前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、可靠、可 测试、高效...
    iOS行者阅读 4,418评论 21 35
  • 使用清晰而协调的命名方式 起名时应遵从标准的Objective-C命名规范,这样创建出来的接口更容易为开发者所理解...
    Mustard_Buli阅读 279评论 0 0
  • 夜,为何扣醒我的梦乡?我坐在黑色又黑色的夜的黑,在黑色的记忆中,再一次碾过你的压痕,你连续不断紧跟其后…紧抽一...
    海上红城阅读 154评论 0 0
  • 五点半吃的晚餐,七点半就饿了。不管是想瘦还是想养生,晚上是不该多吃的。可是饿的难受啊,就把冰箱里剩下的一根红薯煮了...
    一路李花开阅读 238评论 0 0