2.2. 方法(Method)命名

一般性原则

为方法命名时,请考虑如下一些一般性规则:

  • 方法名不要使用new作为前缀。

  • 小写第一个单词的首字符,大写随后单词的首字符,不使用前缀。请参考书写约定一节。有两种例外情况:1.方法名以广为人知的大写字母缩略词(如 TIFF or PDF)开头;2.私有方法可以使用统一的前缀来分组和辨识,请参考私有方法一节

  • 表示对象行为的方法,名称以动词开头:

- (void) invokeWithTarget:(id)target:
- (void) selectTabViewItem:(NSTableViewItem *)tableViewItem

名称中不要出现 do或does,因为这些助动词没什么实际意义。也不要在动词前使用副词或形容词修饰。

  • 如果方法返回方法接收者的某个属性,直接用属性名称命名。不要使用 get，除非是间接返回一个或多个值。请参考访问方法一节。

代码

点评

- (NSSize) cellSize;

对

- (NSSize) calcCellSize;

错

- (NSSize) getCellSize;

错

  • 参数要用描述该参数的关键字命名

代码

点评

- (void) sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;

对

- (void) sendAction:(SEL)aSelector :(id)anObject :(BOOL)flag;

错

  • 参数前面的单词要能描述该参数。

代码

点评

- (id) viewWithTag:(int)aTag;

对

- (id) taggedView:(int)aTag;

错

  • 细化基类中的已有方法:创建一个新方法,其名称是在被细化方法名称后面追加参数关键词

- (id)initWithFrame:(CGRect)frameRect;//NSView, UIView.
- (id)initWithFrame:(NSRect)frameRect mode:(int)aMode  cellClass:(Class)factoryId numberOfRows:(int)rowsHigh numberOfColumns (int)colsWide;//NSMatrix, a subclass of NSView

  • 不要使用 and 来连接用属性作参数的关键字

代码

点评

- (int)runModalForDirectory:(NSString)path file:(NSString)name types:(NSArray *)fileTypes;

对

- (int)runModalForDirectory:(NSString)path andFile:(NSString)name andTypes:(NSArray *)fileTypes;

错

虽然上面的例子中使用 add 看起来也不错,但当你方法有太多参数关键字时就有问题。

  • 如果方法描述两种独立的行为,使用 and 来串接它们

- (BOOL) openFile:(NSString *)fullPath withApplication:(NSString NSWorkspace *)appName andDeactivate:(BOOL)flag;//NSWorkspace.

访问方法

访问方法是对象属性的读取与设置方法。其命名有特定的格式依赖于属性的描述内容。

  • 如果属性是用名词描述的,则命名格式为:

- (void) setNoun:(type)aNoun;
- (type) noun;

例如:

- (void) setgColor:(NSColor *)aColor;
- (NSColor *) color;

  • 如果属性是用形容词描述的,则命名格式为:

- (void) setAdjective:(BOOL)flag;
- (BOOL) isAdjective;

例如:

- (void) setEditable:(BOOL)flag;
- (BOOL) isEditable;

  • 如果属性是用动词描述的,则命名格式为:(动词要用现在时时态)

- (void) setVerbObject:(BOOL)flag;
- (BOOL) verbObject;

例如:

- (void) setShowAlpha:(BOOL)flag; 
- (BOOL) showsAlpha;

  • 不要使用动词的过去分词形式作形容词使用

- (void)setAcceptsGlyphInfo:(BOOL)flag;  //对
- (BOOL)acceptsGlyphInfo;                //对
- (void)setGlyphInfoAccepted:(BOOL)flag; //错
- (BOOL)glyphInfoAccepted;               //错

  • 可以使用情态动词(can, should, will 等)来提高清晰性,但不要使用 do 或 does

- (void) setCanHide:(BOOL)flag;             //对
- (BOOL) canHide;                           //对
- (void) setShouldCloseDocument:(BOOL)flag; //对
- (void) shouldCloseDocument;               //对 
- (void) setDoseAcceptGlyphInfo:(BOOL)flag; //错 
- (BOOL) doseAcceptGlyphInfo;               //错

  • 只有在方法需要间接返回多个值的情况下,才使用 get

- (void) getLineDash:(float *)pattern count:(int *)count phase:(float *)phase;  //NSBezierPath

像上面这样的方法,在其实现里应允许接受 NULL 作为其 in-out 参数,以表示调用者对一个或多个返回值不感兴趣。

委托方法

委托方法是那些在特定事件发生时可被对象调用,并声明在对象的委托类中的方法。它们有独特的命名约定,这些命名约定同样也适用于对象的数据源方法。

  • 名称以标示发送消息的对象的类名开头,省略类名的前缀并小写类第一个字符

- (BOOL)tableView:(NSTableView *)tableView shouldSelectRow:(int)row;
- (BOOL)application:(NSApplication *)sender openFile:(NSString *)filename;

  • 冒号紧跟在类名之后(随后的那个参数表示委派的对象)。该规则不适用于只有一个 sender 参数的方法

- (BOOL)applicationOpenUntitledFile:(NSApplication *)sender;

  • 上面的那条规则也不适用于响应通知的方法。在这种情况下,方法的唯一参数表示通知对象

- (void)windowDidChangeScreen:(NSNotification *)notification;

  • 用于通知委托对象操作即将发生或已经发生的方法名中要使用 did 或 will

- (void)browserDidScroll:(NSBrowser *)sender;
- (NSUndoManager *)windowWillReturnUndoManager:(NSWindow *)window;

  • 用于询问委托对象可否执行某操作的方法名中可使用 did 或 will,但最好使用 should

- (BOOL)windowShouldClose:(id)sender;

集合方法

管理对象(集合中的对象被称之为元素)的集合类,约定要具备如下形式的方法:

- (void)addElement:(elementType)adObj;
- (void)removeElement:(elementType)anObj;
- (NSArray *)elements;

例如:

- (void)addLayoutManager:(NSLayoutManager *)adObj;
- (void)removeLayoutManager:(NSLayoutManager *)anObj; 
- (NSArray *)layoutManagers;

集合方法命名有如下一些限制和约定:

  • 如果集合中的元素无序,返回 NSSet,而不是 NSArray

  • 如果将元素插入指定位置的功能很重要,则需具备如下方法:

- (void)insertElement:(elementType)anObj atIndex:(int)index;
- (void)removeElementAtIndex:(int)index;

集合方法的实现要考虑如下细节:

  • 以上集合类方法通常负责管理元素的所有者关系,在 add 或 insert 的实现代码里会 retain 元素,在 remove 的实现代码中会 release 元素

  • 当被插入的对象需要持有指向集合对象的指针时,通常使用 set... 来命名其设置该指针的方法,且不要 retain 集合对象。比如上面的 insertLayerManager:atIndex: 这种情形,NSLayoutManager 类使用如下方法:

- (void)setTextStorage:(NSTextStorage *)textStorage; 
- (NSTextStorage *)textStorage;

通常你不会直接调用 setTextStorage:,而是覆写它。

另一个关于集合约定的例子来自 NSWindow 类:

- (void)addChildWindow:(NSWindow *)childWin ordered:(NSWindowOrderingMode)place;
- (void)removeChildWindow:(NSWindow *)childWin;
- (NSArray *)childWindows;
- (NSWindow *)parentWindow;
- (void)setParentWindow:(NSWindow *)window;

方法参数

命名方法参数时要考虑如下规则:

  • 如同方法名,参数名小写第一个单词的首字符,大写后继单词的首字符。如:removeObject:(id)anObject

  • 不要在参数名中使用 pointer 或 ptr,让参数的类型来说明它是指针

  • 避免使用 one, two,...,作为参数名

  • 避免为节省几个字符而缩写

按照 Cocoa 惯例,以下关键字与参数联合使用:

...action:(SEL)aSelector 
...alignment:(int)mode 
...atIndex:(int)index 
...content:(NSRect)aRect 
...doubleValue:(double)aDouble 
...floatValue:(float)aFloat 
...font:(NSFont *)fontObj 
...frame:(NSRect)frameRect 
...intValue:(int)anInt
...keyEquivalent:(NSString *)charCode
...length:(int)numBytes
...point:(NSPoint)aPoint
...stringValue:(NSString *)aString
...tag:(int)anInt
...target:(id)anObject
...title:(NSString *)aString

私有方法

大多数情况下,私有方法命名相同与公共方法命名约定相同,但通常我们约定给私有方法添加前缀,以便与公共方法区分开来。即使这样,私有方法的名称很容易导致特别的问题。当你设计一个继承自 Cocoa framework 某个类的子类时,你无法知道你的私有方法是否不小心覆盖了框架中基类的同名方法。

Cocoa framework 的私有方法名称通常以下划线作为前缀(如:_fooData),以标示其私有属性。基于这样的事实,遵循以下两条建议:

  • 不要使用下划线作为你自己的私有方法名称的前缀,Apple 保留这种用法。

  • 若要继承 Cocoa framework 中一个超大的类(如:NSView),并且想要使你的私有方法名称与基类中的区别开来,你可以为你的私有方法名称添加你自己的前缀。这个前缀应该具有唯一性, 建议用"p_Method"格式，p代表private。

尽管为私有方法名称添加前缀的建议与前面类中方法命名的约定冲突,这里的意图有所不同:为了防止不小心地覆盖基类中的私有方法。

Previous2.1. 代码命名基础Next2.3. 函数(Function)命名

Last updated