Objective-C 之优雅的命名(转)

There are only two hard things in Computer Science: cache invalidation and naming things.

在计算机科学中只有两件难事:缓存失效和命名。

— Phil Karlton

计算机语言是人和计算机之间通讯的媒介。好的代码应该是就像人对计算机说话那样,自然而优雅。命名看上去是一件很简单的事,而往往越是简单的事越难做好,否则大师们也不会把命名看成是计算机界的难题了。如何把Objective-C这门计算机语言以优雅的方式“说”出,还是比较考验工程师对它的理解深度的。在苹果的SDK中有大量的API,我们可以从这些API中体会到一些命名的艺术。

减少缩写

命名缩写只用于通用专业术语,如 URL,不可自创命名缩写,如 Ctr、Msg。命名宁可长一些,也不要难于理解。

是否在看别人代码时各种缩写而不知其所以然?简短的名字确实比较好,但不可滥用缩写导致失去可读性。

过程化

动作发生之前用 Will,发生之后用 Did,询问是否发生用 Should。

每个处理都是有一定过程的,这个处理往往会产生一些通知和回调,好的命名必须要明确当前过程中的步骤。命名这些通知和回调时最好提供发生前后两个版本,如果发生前要回调确认,请用 Should 命名该回调,并返回一个 BOOL 值。

名字空间

各种全局作用范围的函数,常量,类,枚举,结构等命名必须加命名前缀。

Objective-C中没有C++那样的名字空间概念,也没有Java包名的概念,随着工程代码的增加,难免会出现名字冲突,因此全局作用范围的名字必须唯一。比较经典的做法就是加命名前缀。大多数人认为命名前缀只是在类的前面加几个大写字母,其实不仅仅如此。

•类型(类、枚举、结构)命名前要加相关模块前缀。

  1. UIView
  2. NSString
  3. CGRect

•常量命名要加相关类型名前缀。

  1. UIApplicationDidFinishLaunchingNotification
  2. CGRectZero

•函数命名要加相关类型名前缀。

  1. CGRectMake
  2. CGPointMake

•枚举类型命名要加相关类名前缀,并且枚举值命名要加枚举类型前缀。

  1. typedef NS_ENUM(NSInteger, UIViewAnimationTransition) {
  2. UIViewAnimationTransitionNone,
  3. UIViewAnimationTransitionFlipFromLeft,
  4. UIViewAnimationTransitionFlipFromRight,
  5. UIViewAnimationTransitionCurlUp,
  6. UIViewAnimationTransitionCurlDown,
  7. };

做到以上几点几乎可以做到名字不会冲突。

参数提示

方法命名时,每个参数前要加参数的名称提示。

  1. - (id)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil
  2. - (void)performSegueWithIdentifier:(NSString *)identifier sender:(id)sender

对象命名

给一个带修饰的对象命名时要采用修饰+类型的方式,而不是先指定其类型。

很多人喜欢把对象的类型放在对象的命名前面,从而来标识一个对象是什么类型,这很不符合Objective-C语言的特点,容易引起歧义,比如一个 UILabel 对象:

  1. titleLabel      //表示标题的label,是UIlabel对象
  2. labelTitle      //label的标题?似乎是一个NSString?
  3. confirmButton   //确认按钮
  4. buttonConfirm   //不自然的命名,看上去像是按钮点击动作。

方法命名符合语法

大部分方法可以分成下面两类,而这两类往往被乱用。它们是:

•要什么

•做什么

“要什么”表示取得某个对象,要以名词作为方法的开头;“做什么”表示执行某种操作,要以动词作为方法开头。看看下面这个命名方式:

  1. - (XXItem *)itemNamed:(NSString *)name           //Good. 意思清晰
  2. - (XXItem *)findItemWithName:(NSString *)name    //更像是一种操作,而不是返回一个对象。

findItemWithName 这个命名表示一种操作,而无需返回对象,比如它可以用于设置类的内部成员,比如:

  1. - (void)findItemWithName:(NSString *)name{
  2. ...
  3. self.foundItem = xxx;
  4. ...
  5. }

get

“要什么”往往被胡乱命名为get开头的方法。首先get是一个动词,所以它还是“做什么”或者说“做的是要什么”。那么get方法不要用于返回对象,但它可用于参数中返回。

  1. - (XXItem *)getItemAtIndex:(NSUInteger)index                  //Bad!! 不规范的命名
  2. - (XXItem *)itemAtIndex:(NSUInteger)index                     //Good, 命名清晰
  3. - (void)getItem:(XXItem **)outItem atIndex:(NSUInteger)index  //比较符合规范,但第二种更好。

可知性

回调时被调用者要知道其调用者

可以在回调方法中第一个参数中加上调用者:

  1. - (BOOL)application:(UIApplication *)application willFinishLaunchingWithOptions:(NSDictionary *)launchOptions
  2. - (void)buttonTapped:(UIButton*)sender

常量还是宏

全局常量不可使用宏定义

我们经常看到一些用宏定义的通知,关键字等。其实这么做是非常危险的,因为宏很可能被重定义,而且引用不同的文件可能会导致宏的不同,所以尽量使用const来定义常量。

一些思考

命名的好坏在开发中往往也不怎么重视,毕竟差的命名也不会影响程序逻辑。但是不好的命名在大项目中带来的隐形维护成本是相当高的,这些在项目开始时可能还很难察觉,而后来会陷入前仆后继的维护困境中。我们往往非常重视项目逻辑的复杂性,却不能好好的把“简单”的命名做好。其实,如果简单的东西都做不好,那么做出再复杂的东西那也是垃圾。

本文转载自cocoachina:http://www.cocoachina.com/applenews/devnews/2014/0816/9395.html

时间: 2024-10-07 22:52:49

Objective-C 之优雅的命名(转)的相关文章

Objective-C之优雅的命名

There are only two hard things in Computer Science: cache invalidation and naming things. 在计算机科学中只有两件难事:缓存失效和命名. — Phil Karlton 计算机语言是人和计算机之间通讯的媒介.好的代码应该是就像人对计算机说话那样,自然而优雅.命名看上去是一件很简单的事,而往往越是简单的事越难 做好,否则大师们也不会把命名看成是计算机界的难题了.如何把Objective-C这门计算机语言以优雅的方

软件开发的流程

1.需求 没有明确的需求不要急着开始干,在需求不明确的前提下,基本上是越早开发坑越多. 2.设计稿 在此应该说是原型图,再好的需求文字描述也不如一张完整的设计图,对于后端开发,没有设计图没关系,主要是要有原型图,在原型图的设计指导下,后端开发人员可以明确接口的调用,数据库的设计,字段的返回以及逻辑的设计,这一点十分的重要.. 以上两点主要是设计和PM的职责,接下来主要说说程序员的工作 3.环境 新的软件系统是部署在新的服务器上还是旧的服务器上,新的服务器,给了你更大的控件,你可以选择更高版本的P

如何让命名变得优雅

1.概述 在写这篇文章时,我也是酝酿了许久:在平时编码时,也经常苦于如何命名让变量,函数及类变都优雅,美观.因为,有时候看回过头来看代码发现,一个变量或是函数名特别是有单词组合都时候,会觉得有些单词组合在一起,看起来很别扭.举个例子,如类型统计:typeStats,statsType,categoryStats,statsCategory.其中2看的最别扭,3其次,1和4都还可以接受.当然这个也不是说2,3不行,这里我只是想说明命名之前,我尽可能的多组合自己的变量,使最后的命名更加优雅. 2.心

如何优雅地使用Sublime Text

Sublime Text:一款具有代码高亮.语法提示.自动完成且反应快速的编辑器软件,不仅具有华丽的界面,还支持插件扩展机制,用她来写代码,绝对是一种享受.相比于难于上手的Vim,浮肿沉重的Eclipse,VS,即便体积轻巧迅速启动的Editplus.Notepad++,在SublimeText面前大略显失色,无疑这款性感无比的编辑器是Coding和Writing最佳的选择,没有之一. 如何优雅地使用Sublime Text之目录: Sublime Text 2和3的对比 Sublime Tex

如何优雅地使用Sublime Text3(转)

转自http://www.jianshu.com/p/3cb5c6f2421c/ Sublime Text:一款具有代码高亮.语法提示.自动完成且反应快速的编辑器软件,不仅具有华丽的界面,还支持插件扩展机制,用她来写代码,绝对是一种享受.相比于难于上手的Vim,浮肿沉重的Eclipse,VS,即便体积轻巧迅速启动的Editplus.Notepad++,在SublimeText面前大略显失色,无疑这款性感无比的编辑器是Coding和Writing最佳的选择,没有之一. 温情提醒:可以移步原文首链处

优雅的css写法

一.利用好代码折叠 css也可以进行优雅的代码折叠而且会比html更好看 折叠后的效果: 这样就可以很舒服的把它折叠起来. 二.向Twitter Bootstrap学习 1. 学习的第一点就是用class,去减少id.当然这是一个很基本的知识. 2. 学习的第二点是命名的词汇. 如group.control.banner.list.item,title.panel.content.container这些表结构和关系的词汇: 还有一些形容词danger.primary.lg.xs.info等等:

Atom:优雅迷人的编辑神器

对于热爱markdown写作的人来说,Atom同样是一款拥有无穷魅力的写作软件.我不怕它无法满足你的需求,就怕你不给一个机会了解它,那么,这将是一场遗憾的错过. 大学的时候,坊间对那些编程高手有一个令人向往的传说,大概说的是大神们能够直接使用text纯文本写代码.觉得这种级别的境界特别高大上特别有逼格.自己用eclipse,vs这些带有代码补全功能的IDE就感觉有点low.于是在很长一段时间里,都是带着信仰去追求这种境界的. 直到后来发现了一款神器,加上认知的慢慢提高,我的这个高大上的信仰,被打

如何写出优雅的CSS代码 ?(转)

对于同样的项目或者是一个网页,尽管最终每个前端开发工程师都可以实现相同的效果,但是他们所写的代码一定是不同的.有的优雅,看起来清晰易懂,代码具有可拓展性,这样的代码有利于团队合作和后期的维护:而有的混乱,虽然表达出了最终的效果,然而却晦涩难懂,显然团队成员在读这样的代码时就显得无从下手,更不利于后期的维护了.那么如何写出优雅的代码呢?下面我将以一个很小的项目就以下几个方面简单的表达一下自己的看法,如有不妥,望批评指正. 如何整理一个项目. 如何写出清晰易懂的HTML代码. 如何写出优雅的css代

C++ vs Objective C

oc Short list of some of the major differences: C++ allows multiple inheritance, Objective-C doesn't.一个允许多继承,一个不允许Unlike C++, Objective-C allows method parameters to be named and the method signature includes only the names and types of the parameter