在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
最近准备开始系统学习一个完整项目的开发流程和思路,在此之前,我们需要对iOS的开发变成规范进行更系统和详尽的学习,随意对编程规范进行了整理和学习。本文内容主要转载自:Objective-C-Coding-Guidelines-In-Chinese 此外,这篇文章所说的一些常见的编码习惯也可以参考一下:iOS开发总结之代码规范
Objective-C编码规范,内容来自苹果、谷歌的文档翻译,自己的编码经验和对其它资料的总结。 Objective-C是一门面向对象的动态编程语言,主要用于编写iOS和Mac应用程序。关于Objective-C的编码规范,苹果和谷歌都已经有很好的总结: 本文主要整合了对上述文档的翻译、作者自己的编程经验和其他的相关资料,为公司总结出一份通用的编码规范。 二 代码格式2.1 使用空格而不是制表符Tab 不要在工程里使用Tab键,使用空格来进行缩进。在 2.2 每一行的最大长度 同样的,在 2.3 函数的书写一个典型的Objective-C函数应该是这样的: - (void)writeVideoFrameWithData:(NSData *)frameData timeStamp:(int)timeStamp { ... } 在 如果一个函数有特别多的参数或者名称很长,应该将其按照 -(id)initWithModel:(IPCModle)model ConnectType:(IPCConnectType)connectType Resolution:(IPCResolution)resolution AuthName:(NSString *)authName Password:(NSString *)password MAC:(NSString *)mac AzIp:(NSString *)az_ip AzDns:(NSString *)az_dns Token:(NSString *)token Email:(NSString *)email Delegate:(id<IPCConnectHandlerDelegate>)delegate; 在分行时,如果第一段名称过短,后续名称可以以Tab的长度(4个空格)为单位进行缩进: - (void)short:(GTMFoo *)theFoo longKeyword:(NSRect)theRect evenLongerKeyword:(float)theInterval error:(NSError **)theError { ... } 2.4 函数调用函数调用的格式和书写差不多,可以按照函数的长短来选择写在一行或者分成多行: //写在一行 [myObject doFooWith:arg1 name:arg2 error:arg3]; //分行写,按照':'对齐 [myObject doFooWith:arg1 name:arg2 error:arg3]; //第一段名称过短的话后续可以进行缩进 [myObj short:arg1 longKeyword:arg2 evenLongerKeyword:arg3 error:arg4]; 以下写法是错误的: //错误,要么写在一行,要么全部分行 [myObject doFooWith:arg1 name:arg2 error:arg3]; [myObject doFooWith:arg1 name:arg2 error:arg3]; //错误,按照':'来对齐,而不是关键字 [myObject doFooWith:arg1 name:arg2 error:arg3]; 2.5 @public和@private标记符@public和@private标记符应该以一个空格来进行缩进: @interface MyClass : NSObject { @public ... @private ... } @end 2.6 协议(Protocols) 在书写协议的时候注意用 @interface MyProtocoledClass : NSObject<NSWindowDelegate> { @private id<MyFancyDelegate> _delegate; } - (void)setDelegate:(id<MyFancyDelegate>)aDelegate; @end 2.7 闭包(Blocks)根据block的长度,有不同的书写规则:
//较短的block写在一行内 [operation setCompletionBlock:^{ [self onOperationDone]; }]; //分行书写的block,内部使用4空格缩进 [operation setCompletionBlock:^{ [self.delegate newDataAvailable]; }]; //使用C语言API调用的block遵循同样的书写规则 dispatch_async(_fileIOQueue, ^{ NSString* path = [self sessionFilePath]; if (path) { // ... } }); //较长的block关键字可以缩进后在新行书写,注意block的右括号'}'和调用block那行代码的第一个非空字符对齐 [[SessionService sharedService] loadWindowWithCompletionBlock:^(SessionWindow *window) { if (window) { [self windowDidLoad:window]; } else { [self errorLoadingWindow]; } }]; //较长的block参数列表同样可以缩进后在新行书写 [[SessionService sharedService] loadWindowWithCompletionBlock: ^(SessionWindow *window) { if (window) { [self windowDidLoad:window]; } else { [self errorLoadingWindow]; } }]; //庞大的block应该单独定义成变量使用 void (^largeBlock)(void) = ^{ // ... }; [_operationQueue addOperationWithBlock:largeBlock]; //在一个调用中使用多个block,注意到他们不是像函数那样通过':'对齐的,而是同时进行了4个空格的缩进 [myObject doSomethingWith:arg1 firstBlock:^(Foo *a) { // ... } secondBlock:^(Bar *b) { // ... }]; 2.8 数据结构的语法糖 应该使用可读性更好的语法糖来构造 如果构造代码写在一行,需要在括号两端留有一个空格,使得被构造的元素于与构造语法区分开来: //正确,在语法糖的"[]"或者"{}"两端留有空格 NSArray *array = @[ [foo description], @"Another String", [bar description] ]; NSDictionary *dict = @{ NSForegroundColorAttributeName : [NSColor redColor] }; //不正确,不留有空格降低了可读性 NSArray* array = @[[foo description], [bar description]]; NSDictionary* dict = @{NSForegroundColorAttributeName: [NSColor redColor]}; 如果构造代码不写在一行内,构造元素需要使用两个空格来进行缩进,右括号 NSArray *array = @[ @"This", @"is", @"an", @"array" ]; NSDictionary *dictionary = @{ NSFontAttributeName : [NSFont fontWithName:@"Helvetica-Bold" size:12], NSForegroundColorAttributeName : fontColor }; 构造字典时,字典的Key和Value与中间的冒号 //正确,冒号':'前后留有一个空格 NSDictionary *option1 = @{ NSFontAttributeName : [NSFont fontWithName:@"Helvetica-Bold" size:12], NSForegroundColorAttributeName : fontColor }; //正确,按照Value来对齐 NSDictionary *option2 = @{ NSFontAttributeName : [NSFont fontWithName:@"Arial" size:12], NSForegroundColorAttributeName : fontColor }; //错误,冒号前应该有一个空格 NSDictionary *wrong = @{ AKey: @"b", BLongerKey: @"c", }; //错误,每一个元素要么单独成为一行,要么全部写在一行内 NSDictionary *alsoWrong= @{ AKey : @"a", BLongerKey : @"b" }; //错误,在冒号前只能有一个空格,冒号后才可以考虑按照Value对齐 NSDictionary *stillWrong = @{ AKey : @"b", BLongerKey : @"c", }; 三 命名规范3.1 基本原则3.1.1 清晰命名应该尽可能的清晰和简洁,但在Objective-C中,清晰比简洁更重要。由于Xcode强大的自动补全功能,我们不必担心名称过长的问题。 //清晰 insertObject:atIndex: //不清晰,insert的对象类型和at的位置属性没有说明 insert:at: //清晰 removeObjectAtIndex: //不清晰,remove的对象类型没有说明,参数的作用没有说明 remove: 不要使用单词的简写,拼写出完整的单词: //清晰 destinationSelection setBackgroundColor: //不清晰,不要使用简写 destSel setBkgdColor: 然而,有部分单词简写在Objective-C编码过程中是非常常用的,以至于成为了一种规范,这些简写可以在代码中直接使用,下面列举了部分: alloc == Allocate max == Maximum alt == Alternate min == Minimum app == Application msg == Message calc == Calculate nib == Interface Builder archive dealloc == Deallocate pboard == Pasteboard func == Function rect == Rectangle horiz == Horizontal Rep == Representation (used in class name such as NSBitmapImageRep). info == Information temp == Temporary init == Initialize vert == Vertical int == Integer 命名方法或者函数时要避免歧义 //有歧义,是返回sendPort还是send一个Port? sendPort //有歧义,是返回一个名字属性的值还是display一个name的动作? displayName 3.1.2 一致性 整个工程的命名风格要保持一致性,最好和苹果SDK的代码保持统一。不同类中完成相似功能的方法应该叫一样的名字,比如我们总是用 3.2 使用前缀如果代码需要打包成Framework给别的工程使用,或者工程项目非常庞大,需要拆分成不同的模块,使用命名前缀是非常有用的。
3.3 命名类和协议(Class&Protocol)
有些协议本身包含了很多不相关的功能,主要用来为某一特定类服务,这时候可以直接用类名来命名这个协议,比如 3.4 命名头文件(Headers)源码的头文件名应该清晰地暗示它的功能和包含的内容:
3.5 命名方法(Methods)Objective-C的方法名通常都比较长,这是为了让程序有更好地可读性,按苹果的说法*“好的方法名应当可以以一个句子的形式朗读出来”*。 方法一般以小写字母打头,每一个后续的单词首字母大写,方法名中不应该有标点符号(包括下划线),有两个例外:
如果方法表示让对象执行一个动作,使用动词打头来命名,注意不要使用 //动词打头的方法表示让对象执行一个动作 - (void)invokeWithTarget:(id)target; - (void)selectTabViewItem:(NSTabViewItem *)tabViewItem; 如果方法是为了获取对象的一个属性值,直接用属性名称来命名这个方法,注意不要添加 //正确,使用属性名来命名方法 - (NSSize)cellSize; //错误,添加了多余的动词前缀 - (NSSize)calcCellSize; - (NSSize)getCellSize; 对于有多个参数的方法,务必在每一个参数前都添加关键词,关键词应当清晰说明参数的作用: //正确,保证每个参数都有关键词修饰 - (void)sendAction:(SEL)aSelector toObject:(id)anObject forAllCells:(BOOL)flag; //错误,遗漏关键词 - (void)sendAction:(SEL)aSelector :(id)anObject :(BOOL)flag; //正确 - (id)viewWithTag:(NSInteger)aTag; //错误,关键词的作用不清晰 - (id)taggedView:(int)aTag; 不要用 //错误,不要使用"and"来连接参数 - (int)runModalForDirectory:(NSString *)path andFile:(NSString *)name andTypes:(NSArray *)fileTypes; //正确,使用"and"来表示两个相对独立的操作 - (BOOL)openFile:(NSString *)fullPath withApplication:(NSString *)appName andDeactivate:(BOOL)flag; 方法的参数命名也有一些需要注意的地方:
下面列举了一些常用参数名: ...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 3.6 存取方法(Accessor Methods)存取方法是指用来获取和设置类属性值的方法,属性的不同类型,对应着不同的存取方法规范: //属性是一个名词时的存取方法范式 - (type)noun; - (void)setNoun:(type)aNoun; //栗子 - (NSString *)title; - (void)setTitle:(NSString *)aTitle; //属性是一个形容词时存取方法的范式 - (BOOL)isAdjective; - (void)setAdjective:(BOOL)flag; //栗子 - (BOOL)isEditable; - (void)setEditable:(BOOL)flag; //属性是一个动词时存取方法的范式 - (BOOL)verbObject; - (void)setVerbObject:(BOOL)flag; //栗子 - (BOOL)showsAlpha; - (void)setShowsAlpha:(BOOL)flag; 命名存取方法时不要将动词转化为被动形式来使用: //正确 - (void)setAcceptsGlyphInfo:(BOOL)flag; - (BOOL)acceptsGlyphInfo; //错误,不要使用动词的被动形式 - (void)setGlyphInfoAccepted:(BOOL)flag; - (BOOL)glyphInfoAccepted; 可以使用 //正确 - (void)setCanHide:(BOOL)flag; - (BOOL)canHide; - (void)setShouldCloseDocument:(BOOL)flag; - (BOOL)shouldCloseDocument; //错误,不要使用"do"或者"does" - (void)setDoesAcceptGlyphInfo:(BOOL)flag; - (BOOL)doesAcceptGlyphInfo; 为什么Objective-C中不适用 //三个参数都是作为函数的返回值来使用的,这样的函数名可以使用"get"前缀 - (void)getLineDash:(float *)pattern count:(int *)count phase:(float *)phase; 3.7 命名委托(Delegate)当特定的事件发生时,对象会触发它注册的委托方法。委托是Objective-C中常用的传递消息的方式。委托有它固定的命名范式。 一个委托方法的第一个参数是触发它的对象,第一个关键词是触发对象的类名,除非委托方法只有一个名为 //第一个关键词为触发委托的类名 - (BOOL)tableView:(NSTableView *)tableView shouldSelectRow:(int)row; - (BOOL)application:(NSApplication *)sender openFile:(NSString *)filename; //当只有一个"sender"参数时可以省略类名 - (BOOL)applicationOpenUntitledFile:(NSApplication *)sender; 根据委托方法触发的时机和目的,使用 - (void)browserDidScroll:(NSBrowser *)sender; - (NSUndoManager *)windowWillReturnUndoManager:(NSWindow *)window; - (BOOL)windowShouldClose:(id)sender; 3.8 集合操作类方法(Collection Methods)有些对象管理着一系列其它对象或者元素的集合,需要使用类似“增删查改”的方法来对集合进行操作,这些方法的命名范式一般为: //集合操作范式 - (void)addElement:(elementType)anObj; - (void)removeElement:(elementType)anObj; - (NSArray *)elements; //栗子 - (void)addLayoutManager:(NSLayoutManager *)obj; - (void)removeLayoutManager:(NSLayoutManager *)obj; - (NSArray *)layoutManagers; 注意,如果返回的集合是无序的,使用 - (void)insertLayoutManager:(NSLayoutManager *)obj atIndex:(int)index; - (void)removeLayoutManagerAtIndex:(int)index; 如果管理的集合元素中有指向管理对象的指针,要设置成 下面是SDK中 - (void)addChildWindow:(NSWindow *)childWin ordered:(NSWindowOrderingMode)place; - (void)removeChildWindow:(NSWindow *)childWin; - (NSArray *)childWindows; - (NSWindow *)parentWindow; - (void)setParentWindow:(NSWindow *)window; 3.9 命名函数(Functions)在很多场合仍然需要用到函数,比如说如果一个对象是一个单例,那么应该使用函数来代替类方法执行相关操作。 函数的命名和方法有一些不同,主要是:
函数名的第一个单词通常是一个动词,表示方法执行的操作: NSHighlightRect
NSDeallocateObject
如果函数返回其参数的某个属性,省略动词: unsigned int NSEventMaskFromType(NSEventType type) float NSHeight(NSRect aRect) 如果函数通过指针参数来返回值,需要在函数名中使用 const char *NSGetSizeAndAlignment(const char *typePtr, unsigned int *sizep, unsigned int *alignp) 函数的返回类型是BOOL时的命名: BOOL NSDecimalIsNotANumber(const NSDecimal *decimal) 3.10 命名属性和实例变量(Properties&Instance Variables)属性和对象的存取方法相关联,属性的第一个字母小写,后续单词首字母大写,不必添加前缀。属性按功能命名成名词或者动词: //名词属性 @property (strong) NSString *title; //动词属性 @property (assign) BOOL showsAlpha; 属性也可以命名成形容词,这时候通常会指定一个带有 @property (assign, getter=isEditable) BOOL editable; 命名实例变量,在变量名前加上 @implementation MyClass { BOOL _showsTitle; } 一般来说,类需要对使用者隐藏数据存储的细节,所以不要将实例方法定义成公共可访问的接口,可以使用 按苹果的说法,不建议在除了 3.11 命名常量(Constants)如果要定义一组相关的常量,尽量使用枚举类型(enumerations),枚举类型的命名规则和函数的命名规则相同。 建议使用 //定义一个枚举 typedef NS_ENUM(NSInteger, NSMatrixMode) { NSRadioModeMatrix, NSHighlightModeMatrix, NSListModeMatrix, NSTrackModeMatrix }; //定义bit map typedef NS_OPTIONS(NSUInteger, NSWindowMask) { NSBorderlessWindowMask = 0, NSTitledWindowMask = 1 << 0, NSClosableWindowMask = 1 << 1, NSMiniaturizableWindowMask = 1 << 2, NSResizableWindowMask = 1 << 3 }; 使用 const float NSLightGray; 不要使用 #ifdef DEBUG
注意到一般由编译器定义的宏会在前后都有一个 3.12 命名通知(Notifications)通知常用于在模块间传递消息,所以通知要尽可能地表示出发生的事件,通知的命名范式是: [触发通知的类名] + [Did | Will] + [动作] + Notification //栗子: NSApplicationDidBecomeActiveNotification NSWindowDidMiniaturizeNotification NSTextViewDidChangeSelectionNotification NSColorPanelColorDidChangeNotification 四 注释读没有注释代码的痛苦你我都体会过,好的注释不仅能让人轻松读懂你的程序,还能提升代码的逼格。注意注释是为了让别人看懂,而不是仅仅你自己。 4.1 文件注释每一个文件都必须写文件注释,文件注释通常包含
一段良好文件注释的栗子: /******************************************************************************* Copyright (C), 2011-2013, Andrew Min Chang File name: AMCCommonLib.h Author: Andrew Chang (Zhang Min) E-mail: [email protected] Description: This file provide some covenient tool in calling library tools. One can easily include library headers he wants by declaring the corresponding macros. I hope this file is not only a header, but also a useful Linux library note. History: 2012-??-??: On about come date around middle of Year 2012, file created as "commonLib.h" 2012-08-20: Add shared memory library; add message queue. 2012-08-21: Add socket library (local) 2012-08-22: Add math library 2012-08-23: Add socket library (internet) 2012-08-24: Add daemon function 2012-10-10: Change file name as "AMCCommonLib.h" 2012-12-04: Add UDP support in AMC socket library 2013-01-07: Add basic data type such as "sint8_t" 2013-01-18: Add CFG_LIB_STR_NUM. 2013-01-22: Add CFG_LIB_TIMER. 2013-01-22: Remove CFG_LIB_DATA_TYPE because there is already AMCDataTypes.h Copyright information: This file was intended to be under GPL protocol. However, I may use this library in my work as I am an employee. And my company may require me to keep it secret. Therefore, this file is neither open source nor under GPL control. ********************************************************************************/ 文件注释的格式通常不作要求,能清晰易读就可以了,但在整个工程中风格要统一。 4.2 代码注释好的代码应该是“自解释”(self-documenting)的,但仍然需要详细的注释来说明参数的意义、返回值、功能以及可能的副作用。 方法、函数、类、协议、类别的定义都需要注释,推荐采用Apple的标准注释风格,好处是可以在引用的地方 有很多可以自动生成注释格式的插件,推荐使用VVDocumenter: 一些良好的注释: /** * Create a new preconnector to replace the old one with given mac address. * NOTICE: We DO NOT stop the old preconnector, so handle it by yourself. * * @param type Connect type the preconnector use. * @param macAddress Preconnector's mac address. */ - (void)refreshConnectorWithConnectType:(IPCConnectType)type Mac:(NSString *)macAddress; /** * Stop current preconnecting when application is going to background. */ -(void)stopRunning; /** * Get the COPY of cloud device with a given mac address. * * @param macAddress Mac address of the device. * * @return Instance of IPCCloudDevice. */ -(IPCCloudDevice *)getCloudDeviceWithMac:(NSString *)macAddress; // A delegate for NSApplication to handle notifications about app // launch and shutdown. Owned by the main app controller. @interface MyAppDelegate : NSObject { ... } @end 协议、委托的注释要明确说明其被触发的条件: /** Delegate - Sent when failed to init connection, like p2p failed. */ -(void)initConnectionDidFailed:(IPCConnectHandler *)handler; 如果在注释中要引用参数名或者方法函数名,使用 // Sometimes we need |count| to be less than zero. // Remember to call |StringWithoutSpaces("foo bar baz")| 定义在头文件里的接口方法、属性必须要有注释! 五 编码风格每个人都有自己的编码风格,这里总结了一些比较好的Cocoa编程风格和注意点。 5.1 不要使用new方法 尽管很多时候能用 5.2 Public API要尽量简洁共有接口要设计的简洁,满足核心的功能需求就可以了。不要设计很少会被用到,但是参数极其复杂的API。如果要定义复杂的方法,使用类别或者类扩展。 5.3 #import和#include
栗子: #import <Cocoa/Cocoa.h> #include <CoreFoundation/CoreFoundation.h> #import "GTMFoo.h" #include "base/basictypes.h" 为什么不全部使用 5.4 引用框架的根头文件上面提到过,每一个框架都会有一个和框架同名的头文件,它包含了框架内接口的所有引用,在使用框架的时候,应该直接引用这个根头文件,而不是其它子模块的头文件,即使是你只用到了其中的一小部分,编译器会自动完成优化的。 //正确,引用根头文件 #import <Foundation/Foundation.h> //错误,不要单独引用框架内的其它头文件 #import <Foundation/NSArray.h> #import <Foundation/NSString.h> 5.5 BOOL的使用 BOOL在Objective-C中被定义为 //错误,无法确定|great|的值是否是YES(1),不要将BOOL值直接与YES比较 BOOL great = [foo isGreat]; if (great == YES) // ...be great! //正确 BOOL great = [foo isGreat]; if (great) // ...be great! 同样的,也不要将其它类型的值作为BOOL来返回,这种情况下,BOOL变量只会取值的最后一个字节来赋值,这样很可能会取到0(NO)。但是,一些逻辑操作符比如 //错误,不要将其它类型转化为BOOL返回 - (BOOL)isBold { return [self fontTraits] & NSFontBoldTrait; } - (BOOL)isValid { return [self stringValue]; } //正确 - (BOOL)isBold { return ([self fontTraits] & NSFontBoldTrait) ? YES : NO; } //正确,逻辑操作符可以直接转化为BOOL - (BOOL)isValid { return [self stringValue] != nil; } - (BOOL)isEnabled { return [self isValid] && [self isBold]; } 另外BOOL类型可以和 5.6 使用ARC除非想要兼容一些古董级的机器和操作系统,我们没有理由放弃使用ARC。在最新版的Xcode(6.2)中,ARC是自动打开的,所以直接使用就好了。 5.7 在init和dealloc中不要用存取方法访问实例变量 |
请发表评论