命名规范

基本原则

清晰

命名应该尽可能的清晰和简洁，但在Objective-C中，清晰比简洁更重要。由于Xcode强大的自动补全功能，我们不必担心名称过长的问题。

  1. //清晰
  2. insertObject:atIndex:
  4. //不清晰，insert的对象类型和at的位置属性没有说明
  5. insert:at:
  7. //清晰
  8. removeObjectAtIndex:
  10. //不清晰，remove的对象类型没有说明，参数的作用没有说明
  11. remove:

不要使用单词的简写，拼写出完整的单词：

  1. //清晰
  2. destinationSelection
  3. setBackgroundColor:
  5. //不清晰，不要使用简写
  6. destSel
  7. setBkgdColor:

然而，有部分单词简写在Objective-C编码过程中是非常常用的，以至于成为了一种规范，这些简写可以在代码中直接使用，下面列举了部分：

  1. alloc   == Allocate                    max    == Maximum
  2. alt     == Alternate                min    == Minimum
  3. app     == Application                msg    == Message
  4. calc    == Calculate                nib    == Interface Builder archive
  5. dealloc == Deallocate                pboard == Pasteboard
  6. func    == Function                    rect   == Rectangle
  7. horiz   == Horizontal                Rep    == Representation (used in class name such as NSBitmapImageRep).
  8. info    == Information                temp   == Temporary
  9. init    == Initialize                vert   == Vertical
  10. int     == Integer

命名方法或者函数时要避免歧义

  1. //有歧义，是返回sendPort还是send一个Port？
  2. sendPort
  4. //有歧义，是返回一个名字属性的值还是display一个name的动作？
  5. displayName

一致性

整个工程的命名风格要保持一致性，最好和苹果SDK的代码保持统一。不同类中完成相似功能的方法应该叫一样的名字，比如我们总是用count来返回集合的个数，不能在A类中使用count而在B类中使用getNumber。

使用前缀

如果代码需要打包成Framework给别的工程使用，或者工程项目非常庞大，需要拆分成不同的模块，使用命名前缀是非常有用的。

  • 前缀由大写的字母缩写组成，比如Cocoa中NS前缀代表Founation框架中的类，IB则代表Interface Builder框架。

  • 可以在为类、协议、函数、常量以及typedef宏命名的时候使用前缀，但注意不要为成员变量或者方法使用前缀，因为他们本身就包含在类的命名空间内。

  • 命名前缀的时候不要和苹果SDK框架冲突。

命名类和协议（Class&Protocol）

类名以大写字母开头，应该包含一个名词来表示它代表的对象类型，同时可以加上必要的前缀，比如NSString, NSDate, NSScanner, NSApplication等等。

而协议名称应该清晰地表示它所执行的行为，而且要和类名区别开来，所以通常使用ing词尾来命名一个协议，比如NSCopying,NSLocking。

有些协议本身包含了很多不相关的功能，主要用来为某一特定类服务，这时候可以直接用类名来命名这个协议，比如NSObject协议，它包含了id对象在生存周期内的一系列方法。

命名头文件（Headers）

源码的头文件名应该清晰地暗示它的功能和包含的内容：

  • 如果头文件内只定义了单个类或者协议，直接用类名或者协议名来命名头文件，比如NSLocale.h定义了NSLocale类。

  • 如果头文件内定义了一系列的类、协议、类别，使用其中最主要的类名来命名头文件，比如NSString.h定义了NSString和NSMutableString。

  • 每一个Framework都应该有一个和框架同名的头文件，包含了框架中所有公共类头文件的引用，比如Foundation.h

  • Framework中有时候会实现在别的框架中类的类别扩展，这样的文件通常使用被扩展的框架名+Additions的方式来命名，比如NSBundleAdditions.h。

命名方法（Methods）

Objective-C的方法名通常都比较长，这是为了让程序有更好地可读性，按苹果的说法“好的方法名应当可以以一个句子的形式朗读出来”。

方法一般以小写字母打头，每一个后续的单词首字母大写，方法名中不应该有标点符号（包括下划线），有两个例外：

  • 可以用一些通用的大写字母缩写打头方法，比如PDF,TIFF等。
  • 可以用带下划线的前缀来命名私有方法或者类别中的方法。

如果方法表示让对象执行一个动作，使用动词打头来命名，注意不要使用do，does这种多余的关键字，动词本身的暗示就足够了：

  1. //动词打头的方法表示让对象执行一个动作
  2. - (void)invokeWithTarget:(id)target;
  3. - (void)selectTabViewItem:(NSTabViewItem *)tabViewItem;

如果方法是为了获取对象的一个属性值，直接用属性名称来命名这个方法，注意不要添加get或者其他的动词前缀：

  1. //正确，使用属性名来命名方法
  2. - (NSSize)cellSize;
  4. //错误，添加了多余的动词前缀
  5. - (NSSize)calcCellSize;
  6. - (NSSize)getCellSize;

对于有多个参数的方法，务必在每一个参数前都添加关键词，关键词应当清晰说明参数的作用：

  1. //正确，保证每个参数都有关键词修饰
  2. - (void)sendAction:(SEL)aSelector toObject:(id)anObject forAllCells:(BOOL)flag;
  4. //错误，遗漏关键词
  5. - (void)sendAction:(SEL)aSelector :(id)anObject :(BOOL)flag;
  7. //正确
  8. - (id)viewWithTag:(NSInteger)aTag;
  10. //错误，关键词的作用不清晰
  11. - (id)taggedView:(int)aTag;

不要用and来连接两个参数，通常and用来表示方法执行了两个相对独立的操作（从设计上来说，这时候应该拆分成两个独立的方法）：

  1. //错误，不要使用"and"来连接参数
  2. - (int)runModalForDirectory:(NSString *)path andFile:(NSString *)name andTypes:(NSArray *)fileTypes;
  4. //正确，使用"and"来表示两个相对独立的操作
  5. - (BOOL)openFile:(NSString *)fullPath withApplication:(NSString *)appName andDeactivate:(BOOL)flag;

方法的参数命名也有一些需要注意的地方:

  • 和方法名类似，参数的第一个字母小写，后面的每一个单词首字母大写
  • 不要再方法名中使用类似pointer,ptr这样的字眼去表示指针，参数本身的类型足以说明
  • 不要使用只有一两个字母的参数名
  • 不要使用简写，拼出完整的单词

下面列举了一些常用参数名：

  1. ...action:(SEL)aSelector
  2. ...alignment:(int)mode
  3. ...atIndex:(int)index
  4. ...content:(NSRect)aRect
  5. ...doubleValue:(double)aDouble
  6. ...floatValue:(float)aFloat
  7. ...font:(NSFont *)fontObj
  8. ...frame:(NSRect)frameRect
  9. ...intValue:(int)anInt
  10. ...keyEquivalent:(NSString *)charCode
  11. ...length:(int)numBytes
  12. ...point:(NSPoint)aPoint
  13. ...stringValue:(NSString *)aString
  14. ...tag:(int)anInt
  15. ...target:(id)anObject
  16. ...title:(NSString *)aString

存取方法（Accessor Methods）

存取方法是指用来获取和设置类属性值的方法，属性的不同类型，对应着不同的存取方法规范：

  1. //属性是一个名词时的存取方法范式
  2. - (type)noun;
  3. - (void)setNoun:(type)aNoun;
  4. //栗子
  5. - (NSString *)title;
  6. - (void)setTitle:(NSString *)aTitle;
  8. //属性是一个形容词时存取方法的范式
  9. - (BOOL)isAdjective;
  10. - (void)setAdjective:(BOOL)flag;
  11. //栗子
  12. - (BOOL)isEditable;
  13. - (void)setEditable:(BOOL)flag;
  15. //属性是一个动词时存取方法的范式
  16. - (BOOL)verbObject;
  17. - (void)setVerbObject:(BOOL)flag;
  18. //栗子
  19. - (BOOL)showsAlpha;
  20. - (void)setShowsAlpha:(BOOL)flag;

命名存取方法时不要将动词转化为被动形式来使用：

  1. //正确
  2. - (void)setAcceptsGlyphInfo:(BOOL)flag;
  3. - (BOOL)acceptsGlyphInfo;
  5. //错误，不要使用动词的被动形式
  6. - (void)setGlyphInfoAccepted:(BOOL)flag;
  7. - (BOOL)glyphInfoAccepted;

可以使用can,should,will等词来协助表达存取方法的意思，但不要使用do,和does：

  1. //正确
  2. - (void)setCanHide:(BOOL)flag;
  3. - (BOOL)canHide;
  4. - (void)setShouldCloseDocument:(BOOL)flag;
  5. - (BOOL)shouldCloseDocument;
  7. //错误，不要使用"do"或者"does"
  8. - (void)setDoesAcceptGlyphInfo:(BOOL)flag;
  9. - (BOOL)doesAcceptGlyphInfo;

为什么Objective-C中不适用get前缀来表示属性获取方法？因为get在Objective-C中通常只用来表示从函数指针返回值的函数：

  1. //三个参数都是作为函数的返回值来使用的，这样的函数名可以使用"get"前缀
  2. - (void)getLineDash:(float *)pattern count:(int *)count phase:(float *)phase;

命名委托（Delegate）

当特定的事件发生时，对象会触发它注册的委托方法。委托是Objective-C中常用的传递消息的方式。委托有它固定的命名范式。

一个委托方法的第一个参数是触发它的对象，第一个关键词是触发对象的类名，除非委托方法只有一个名为sender的参数：

  1. //第一个关键词为触发委托的类名
  2. - (BOOL)tableView:(NSTableView *)tableView shouldSelectRow:(int)row;
  3. - (BOOL)application:(NSApplication *)sender openFile:(NSString *)filename;
  5. //当只有一个"sender"参数时可以省略类名
  6. - (BOOL)applicationOpenUntitledFile:(NSApplication *)sender;

根据委托方法触发的时机和目的，使用should,will,did等关键词

  1. - (void)browserDidScroll:(NSBrowser *)sender;
  3. - (NSUndoManager *)windowWillReturnUndoManager:(NSWindow *)window;、
  5. - (BOOL)windowShouldClose:(id)sender;

集合操作类方法（Collection Methods）

有些对象管理着一系列其它对象或者元素的集合，需要使用类似“增删查改”的方法来对集合进行操作，这些方法的命名范式一般为：

  1. //集合操作范式
  2. - (void)addElement:(elementType)anObj;
  3. - (void)removeElement:(elementType)anObj;
  4. - (NSArray *)elements;
  6. //栗子
  7. - (void)addLayoutManager:(NSLayoutManager *)obj;
  8. - (void)removeLayoutManager:(NSLayoutManager *)obj;
  9. - (NSArray *)layoutManagers;

注意，如果返回的集合是无序的，使用NSSet来代替NSArray。如果需要将元素插入到特定的位置，使用类似于这样的命名：

  1. - (void)insertLayoutManager:(NSLayoutManager *)obj atIndex:(int)index;
  2. - (void)removeLayoutManagerAtIndex:(int)index;

如果管理的集合元素中有指向管理对象的指针，要设置成weak类型以防止引用循环。

下面是SDK中NSWindow类的集合操作方法：

  1. - (void)addChildWindow:(NSWindow *)childWin ordered:(NSWindowOrderingMode)place;
  2. - (void)removeChildWindow:(NSWindow *)childWin;
  3. - (NSArray *)childWindows;
  4. - (NSWindow *)parentWindow;
  5. - (void)setParentWindow:(NSWindow *)window;

命名函数（Functions）

在很多场合仍然需要用到函数，比如说如果一个对象是一个单例，那么应该使用函数来代替类方法执行相关操作。

函数的命名和方法有一些不同，主要是：

  • 函数名称一般带有缩写前缀，表示方法所在的框架。
  • 前缀后的单词以“驼峰”表示法显示，第一个单词首字母大写。

函数名的第一个单词通常是一个动词，表示方法执行的操作：

  1. NSHighlightRect
  2. NSDeallocateObject

如果函数返回其参数的某个属性，省略动词：

  1. unsigned int NSEventMaskFromType(NSEventType type)
  2. float NSHeight(NSRect aRect)

如果函数通过指针参数来返回值，需要在函数名中使用Get：

  1. const char *NSGetSizeAndAlignment(const char *typePtr, unsigned int *sizep, unsigned int *alignp)

函数的返回类型是BOOL时的命名：

  1. BOOL NSDecimalIsNotANumber(const NSDecimal *decimal)

命名属性和实例变量（Properties&Instance Variables）

属性和对象的存取方法相关联，属性的第一个字母小写，后续单词首字母大写，不必添加前缀。属性按功能命名成名词或者动词：

  1. //名词属性
  2. @property (strong) NSString *title;
  4. //动词属性
  5. @property (assign) BOOL showsAlpha;

属性也可以命名成形容词，这时候通常会指定一个带有is前缀的get方法来提高可读性：

  1. @property (assign, getter=isEditable) BOOL editable;

命名实例变量，在变量名前加上_前缀（有些有历史的代码会将_放在后面），其它和命名属性一样：

  1. @implementation MyClass {
  2.     BOOL _showsTitle;
  3. }

一般来说，类需要对使用者隐藏数据存储的细节，所以不要将实例方法定义成公共可访问的接口，可以使用@private，@protected前缀。

按苹果的说法，不建议在除了init和dealloc方法以外的地方直接访问实例变量，但很多人认为直接访问会让代码更加清晰可读，只在需要计算或者执行操作的时候才使用存取方法访问，我就是这种习惯，所以这里不作要求。

命名常量（Constants）

如果要定义一组相关的常量，尽量使用枚举类型（enumerations），枚举类型的命名规则和函数的命名规则相同。
建议使用 NS_ENUM 和 NS_OPTIONS 宏来定义枚举类型，参见官方的 Adopting Modern Objective-C 一文：

  1. //定义一个枚举
  2. typedef NS_ENUM(NSInteger, NSMatrixMode) {
  3.     NSRadioModeMatrix,
  4.     NSHighlightModeMatrix,
  5.     NSListModeMatrix,
  6.     NSTrackModeMatrix
  7. };

定义bit map：

  1. typedef NS_OPTIONS(NSUInteger, NSWindowMask) {
  2.     NSBorderlessWindowMask      = 0,
  3.     NSTitledWindowMask          = 1 << 0,
  4.     NSClosableWindowMask        = 1 << 1,
  5.     NSMiniaturizableWindowMask  = 1 << 2,
  6.     NSResizableWindowMask       = 1 << 3
  7. };

使用const定义浮点型或者单个的整数型常量，如果要定义一组相关的整数常量，应该优先使用枚举。常量的命名规范和函数相同：

  1. const float NSLightGray;

不要使用#define宏来定义常量，如果是整型常量，尽量使用枚举，浮点型常量，使用const定义。#define通常用来给编译器决定是否编译某块代码，比如常用的：

  1. #ifdef DEBUG

注意到一般由编译器定义的宏会在前后都有一个__，比如__MACH__。

命名通知（Notifications）

通知常用于在模块间传递消息，所以通知要尽可能地表示出发生的事件，通知的命名范式是：

  1. [触发通知的类名] + [Did | Will] + [动作] + Notification

栗子：

  1. NSApplicationDidBecomeActiveNotification
  2. NSWindowDidMiniaturizeNotification
  3. NSTextViewDidChangeSelectionNotification
  4. NSColorPanelColorDidChangeNotification