谷歌Objective-C编码规范
2013-09-06 09:06
375 查看
背景介绍
Objective-C是一种动态的面向对象的语言，它是C的扩展。它被设计成具有易读易用的，支持复杂的面向对象设计的编程语言。它是Mac
OSX以及iPhone的主要开发语言。
Cocoa是MacOSX的主要的应用程序框架。它由一组支持MacOSX全部特性的，并可用于快速开发的Objective-C类构成。
苹果公司已经撰写了非常全面的Objective-C编码指南。Google也为C++写了类型的编码指南。这个Objective-C指南是苹果和Google最佳实践的结合。因此，在阅读本指南之前，请确定你已经读过以下内容：
Apple'sCocoaCodingGuidelines
Google'sOpenSourceC++StyleGuide
注意：所有在Google的C++编码指南中所禁止的事情，如未有特殊提及，也同样不能在Objective-C++中使用。
本文档的目的在于为所有的MacOSX的代码提供编程指南及最佳实践。许多指南是在实际的项目及小组中经过长期的演进及验证的。Google开发的开源项目遵从本指南的要求。
Google已经发布了GoogleToolboxforMacproject的部分开源代码，这些代码遵从本指南。跨多个项目的代码是这个库中的较好候选。
请注意，本指南不是Objective-C的教程。我们假定读者已经对Objective-C非常熟悉。如果你刚刚接触Objective-C或者需要提高，请阅读Programming
withObjective-C。
例子
一个例子顶上一千句话，我们就从这样的一个例子开始，来感受一下编码的风格、空格以及命名等等。
一个头文件的例子，展示了在@interface声明中如何进行正确的注释以及空格。
#import<Foundation/Foundation.h>
//AsampleclassdemonstratinggoodObjective-Cstyle.Allinterfaces,
//categories,andprotocols(read:alltop-leveldeclarationsinaheader)
//MUSTbecommented.Commentsmustalsobeadjacenttotheobjectthey're
//documenting.
//
//(noblanklinebetweenthiscommentandtheinterface)
@interfaceFoo:NSObject{
@private
NSString*_bar;
NSString*_bam;
}
//ReturnsanautoreleasedinstanceofFoo.See-initWithBar:fordetails
//about|bar|.
+(id)fooWithBar:(NSString*)bar;
//Designatedinitializer.|bar|isathingthatrepresentsathingthat
//doesathing.
-(id)initWithBar:(NSString*)bar;
//Getsandsets|_bar|.
-(NSString*)bar;
-(void)setBar:(NSString*)bar;
//Doessomeworkwith|blah|andreturnsYESiftheworkwascompleted
//successfully,andNOotherwise.
-(BOOL)doWorkWithBlah:(NSString*)blah;
@end
一个实现文件的例子，展示了@implementation部分如何进行正确的注释、空格。同时也包括了基于引用实现的一些重要方法，如getters、setters、init以及dealloc。
#import"Foo.h"
@implementationFoo
+(id)fooWithBar:(NSString*)bar{
return[[[selfalloc]initWithBar:bar]autorelease];
}
//Mustalwaysoverridesuper'sdesignatedinitializer.
-(id)init{
return[selfinitWithBar:nil];
}
-(id)initWithBar:(NSString*)bar{
if((self=[superinit])){
_bar=[barcopy];
_bam=[[NSStringalloc]initWithFormat:@"hi%d",3];
}
returnself;
}
-(void)dealloc{
[_barrelease];
[_bamrelease];
[superdealloc];
}
-(NSString*)bar{
return_bar;
}
-(void)setBar:(NSString*)bar{
[_barautorelease];
_bar=[barcopy];
}
-(BOOL)doWorkWithBlah:(NSString*)blah{
//...
returnNO;
}
@end
@interface,@implementation,
和@end前后的空白行是可以选的。如果@interface声明了实例变量，在右括号后必须有空白行。
除非接口或实现非常短，比如声明了一撮私有方法或bridge类，增加空白行通常可以提高可读性。
空格与格式
空格与制表符
只使用空格，每次缩进两个空格。
我们使用空格进行缩进。不要在代码中使用制表符。你应该将你的文本编辑器设置成自动将制表符替换成空格。
行宽
代码中的每行最多有80个字符。
即使Objective-C比C++更加冗长，为了保证本指南的可操作性，我们决定保持每行宽度为80列。这比你想的要简单。
我们意识到这条规则是有争议的，但很多已经存在的代码坚持了本规则，因此我们觉得保证一致性更重要。
通过设置Xcode>Preferences>TextEditing>Showpageguide.，来使越界更容易被发现。
方法声明与定义
-或者+与返回类型之间，需要有空格。参数列表中，只有参数之间有空格。
方法应该像这样：
-(void)doSomethingWithString:(NSString*)theString{
...
}
星号前的空格是可选的。当写新的代码时，要与原的代码一致。
如果一行有非常多的参数，更好的方式是将每个参数单独拆成一行。如果使用多行，将每个参数前的冒号对齐。
当第一个关键字比其它的短时，保证下一行至少有4个空格的缩进。这样可以使关键字垂直对齐，而不是使用冒号对齐：
方法调用
方法定义的格式与方法声明的格式非常相似。当格式的风格有多种选择时，新的代码要与已经存在的代码保持一致。
方法调用时，所有参数应该在同一行。
或者每行一个参数，以冒号对齐：
不要使用下面的缩进风格：
方法定义与方法声明一样，当关键字的长度不足以以冒号对齐时，下一行都要以四个空格进行缩进。
调用包含内联blocks时需要让它的代码段4个空格缩进左对齐
@public与@private
@public以及@private访问标识符应该以一个空格缩进。
与C++中的public,private,以及protected非常相似。
异常
每个@标签应该有独立的一行，在@与左大括号({)之间需要有一个空格。@catch与被捕捉到的异常对象的声明之间也要有一个空格。
如果你必须使用Objective-C的异常，按下面的格式进行编码代码。然后，请参见Avoid
ThrowingExceptions来了解不应该使用异常的原因。
协议
尖括号所包括的协议名称与前面的类型标识之间不应该有空格。
这条规则也同样适用于类声明、成员变量以及方法声明。例如：
Blocks
Block是创建callback回调时首选的target-selector目标选择器模式，因为它使代码更易于阅读。Block里面的代码块应缩进4个空格。
下面是一些相应的风格规则，取决于block有多长：
如果block能一行写完，不要分行。
如果有分行，右大括号必须与block声明的那一行的第一个字符对齐。
block内的代码必须缩进4个空格。
如果block代码很多，比如，超过20行，建议移到外面用一个本地变量保存。
如果block没有参数，在字符^{之间不要有空格，如果block有参数，字符^(之间不要有空格，但字符){之间有一个空格。
包含内联block的调用可以让其代码段左对齐四空间缩进。这有助于理解包含多个内嵌块的调用。
两个空间内缩进块也可以，但应该只用于保持与项目其他代码风格一致性时。
//Theentireblockfitsononeline.
[operationsetCompletionBlock:^{[selfonOperationDone];}];
//Theblockcanbeputonanewline,indentedfourspaces,withthe
//closingbracealignedwiththefirstcharacterofthelineonwhich
//blockwasdeclared.
[operationsetCompletionBlock:^{
[self.delegatenewDataAvailable];
}];
//UsingablockwithaCAPIfollowsthesamealignmentandspacing
//rulesaswithObjective-C.
dispatch_async(_fileIOQueue,^{
NSString*path=[selfsessionFilePath];
if(path){
//...
}
});
//Anexamplewheretheparameterwrapsandtheblockdeclarationfits
//onthesameline.Notethespacingof|^(SessionWindow*window){|
//comparedto|^{|above.
[[SessionServicesharedService]
loadWindowWithCompletionBlock:^(SessionWindow*window){
if(window){
[selfwindowDidLoad:window];
}else{
[selferrorLoadingWindow];
}
}];
//Anexamplewheretheparameterwrapsandtheblockdeclarationdoes
//notfitonthesamelineasthename.
[[SessionServicesharedService]
loadWindowWithCompletionBlock:
^(SessionWindow*window){
if(window){
[selfwindowDidLoad:window];
}else{
[selferrorLoadingWindow];
}
}];
//Largeblockscanbedeclaredout-of-line.
void(^largeBlock)(void)=^{
//...
};
[_operationQueueaddOperationWithBlock:largeBlock];
//Anexamplewithmultipleinlinedblocksinoneinvocation.
[myObjectdoSomethingWith:arg1
firstBlock:^(Foo*a){
//...
}
secondBlock:^(Bar*b){
//...
}];
容器常量
使用Xcode4.4或更高版本的的项目，鼓励使用容器常量。如果被分成了多行，其内容需两个空白字符缩进。
如果集合内容只有一行，开始中括号[之后和结束中括号]之前需要一个空格。
NSArray*array=@[[foodescription],@"AnotherString",[bardescription]];
NSDictionary*dict=@{NSForegroundColorAttributeName:[NSColorredColor]};
而不是:
NSArray*array=@[[foodescription],[bardescription]];
NSDictionary*dict=@{NSForegroundColorAttributeName:[NSColorredColor]};
如果集合跨越超过一行，左中括号[单独位于声明的那一行，内容缩进两个空格，右括号位于新行并与声明左中括号的行开头对齐。
NSArray*array=@[
@"This",
@"is",
@"an",
@"array"
];
NSDictionary*dictionary=@{
NSFontAttributeName:[NSFontfontWithName:@"Helvetica-Bold"size:12],
NSForegroundColorAttributeName:fontColor
};
对于字典常量，冒号前后应该有一个空格（值是否对齐是可选的）
NSDictionary*option1=@{
NSFontAttributeName:[NSFontfontWithName:@"Helvetica-Bold"size:12],
NSForegroundColorAttributeName:fontColor
};
NSDictionary*option2=@{
NSFontAttributeName:[NSFontfontWithName:@"Arial"size:12],
NSForegroundColorAttributeName:fontColor
};
如下是错误的：
//Thereshouldbeaspacebeforethecolon.
NSDictionary*wrong=@{
AKey:@"b",
BLongerKey:@"c",
};
//Theitemsshouldeachbeonanewline,ortheentireexpression
//shouldfitononeline.
NSDictionary*alsoWrong=@{AKey:@"a",
BLongerKey:@"b"};
//Thereshouldbenovariablespacebeforethecolon,onlyafter.
NSDictionary*stillWrong=@{
AKey:@"b",
BLongerKey:@"c",
};
命名
对于可维护的代码，命名规则非常重要。Objective-C的方法名往往十分长，但代码块读起来就像散文一样，不需要太多的注释修饰。
当编写纯Objective-C代码时，我们基本遵守标准的Objective-C
namingrules，这些命名规则可能与C++风格指南中的大相径庭。例如，Google的C++风格指南中推荐使用下划线分隔的单词作为变量名，而(苹果的)风格指南则使用camel命名法，这在Objective-C社区中非常普遍。
任何的类、分类、方法以及变量的名字中都使用全大写缩写。这遵守了苹果的标准命名方式，如URL、TIFF以及EXIF。
当编写Objective-C++代码时，事情就不这么简单了。许多的项目需要实现跨平台的C++代码，并与Objective-C以及Cocoa混合编写。或者以C++作为后端，Cocoa作为前端。这就导致了两种命名方式直接不统一。
我们的解决方案是：编码风格取决于方法/函数以哪种语言实现。如果在一个@implementation语句块中，就使用Objective-C的风格。如果实现一个C++的类，请使用C++的风格。这避免了成员变量与局部变量使用混合的命名风格，这会严重地影响可读性。
文件名
文件名应该反映了它实现了什么类。遵守你的项目的惯例。
文件的扩展名应该如下：
分类的文件名应该包含被扩展的类的名字，如：
GTMNSString+Utils.h或GTMNSTextView+Autocomplete.h。
Objective-C++
当编写源代码时，Ojbective-C++应该采用你正在实现的方法/函数的风格。
为了最小化Cocoa/Objective-C与C++之间的命名风格的冲突，按照下面方法实现的风格编写代码。在实现@implementation语句块时，使用Objective-C的命名规则；如果实现一个C++的类，就使用C++命名规则。
类名
类名、分类名、协议名应该以大写字母开始，并混合小写字母来分隔单词。(Camel命名法)
应用程序级的代码，应该尽量避免不必要的前缀。为每个类都添加前缀不会提高任何的可读性。当设计跨不同应用程序的代码时，应该使用前缀，例如：GTMSendMessage。
类别名
类别名应该有两三个字母的前缀以表示类别是项目的一部分或者该类别是通用的。类别应该包含它所扩展的类的名字。
例如，录我们要创建一个NSString的类别以解析时，我们将把类别放在一个名为GTMNSString+Parsing.h的文件中。类别名本身的名字是GTMStringParsingAdditions（是的，我们知道类别名和文件名不一样，但是这个文件中可能存在多个不同的与解析有关类别）。类别中的方法应该以gtm_myCategoryMethodOnAString为前缀以避免命名冲突，因为Objective-C只有一个命名空间。如果代码不会被分享并且不会被运行在不同的地址空间中，方法名字就不那么重要。
类名与包含类别名的括号之间，应该以一个空格分隔。
Objective-C方法名
方法名应该以小写字母开头，并混合大小写（Camel命名法）。每个命名的参数也应该以小写字母开头。
方法名应该读起来就像句子，这表示你应该选择与方法名连在一起读起来通顺的参数名。(例如，convertPoint:fromRect:orreplaceCharactersInRange:withString:)参见Apple's
GuidetoNamingMethods。
访问器方法应该与他们getting的的成员变量的名字一样，但不应该以get作为前缀。例如：
这仅限于Objective-C的方法名。C++的方法与函数的命名规则应该遵从C++风格指南中的规则。
变量名
变量名应该以小写字母开头，并混合大小写。类的成员变量应该以下划线作为前缀。例如：myLocalVariable,_myInstanceVariable。
常用变量名
对于静态的类别，如int以及指针等，不要使用匈牙利命名法。要为变量起一个描述性的名字。不要担心浪费列宽，因为让新的代码阅读者立即理解你的代码更重要。例如：
intw;
intnerr;
intnCompConns;
tix=[[NSMutableArrayalloc]init];
obj=[someObjectobject];
p=[networkport];
intnumErrors;
intnumCompletedConnections;
tickets=[[NSMutableArrayalloc]init];
userInfo=[someObjectobject];
port=[networkport];
成员变量
成员变量应该混合大小写，并以下划线作为前缀，如_usernameTextField。然而，由于历史惯例是将下划线作名称后缀。项目可能为了保持一致性而继续使用下划线后缀。建议你放弃使用旧的风格，除非这样会导致一个类的风格不一致性。
常量
常量名（如宏、枚举、静态局部变量等）应该以小写字母k开头，使用混合大小写的格式来分隔单词，如：
因为Objective-C没有提供命名空间，全局范围内的常量应该有一个适当的前缀来减小命名冲突，典型的类似kClassNameFoo。
注释
虽然写起来很痛苦，但注释是保证代码可读性的关键。下面的规则给出了你应该什么时候、在哪进行注释。记住：尽量注释很重要，但最好的代码应该自成文档。与其给类型及变量起一个晦涩难懂的名字，再为它写注释，不如直接起一个有意义的名字。
当你写注释的时候，记得你在给你的听众写，即下一个需要阅读你的代码的。大方一点，下一个读代码的人可能就是你！
记住所有C++风格指南里的规则在这里也同样适用，不同的地方会在下面指出。
文件注释
以版权信息作为文件头部，开始每一个文件，后接文件内容的描述。
每个文件应该按顺序包括如下内容：
版权信息声明（如：Copyright2008GoogleInc.）授权样版。选择一个合适的项目所使用的授权样板（例如，Apache2.0,BSD,LGPL,GPL）。
对文件内容必要的基本描述。
如果你对其他人的原始代码作出重大的修改，请把你的名字添加到作者里面。当另外一个代码贡献者对文件有问题时，他需要知道怎么联系你，这十分有用。
声明注释
每个接口、类别以及协议应该注释，以描述它的目的及作用。
如果你已经在文件头部详细描述了接口，可以直接说明“完整的描述请参见文件头部”，但是一定要有这部分注释。
另外，公共接口的每个方法，都应该有注释来解释它的作用、参数、返回值以及其它影响。
为类的线程安全性作注释，如果有的话。如果类的实例可以被多个线程访问，记得注释多线程条件下的使用规则。
实现注释
使用竖线|来引用注释中的变量名及符号名而不是使用引号。
这会避免二义性，尤其是当符号是一个常用词汇，这使用语句读起来很糟糕。例如，对于符号"count"：
或者当引用已经包含引号的符号：
对象所有权
当与Objective-C最通常的做法不同时，尽量使用指针的所有权模型尽量直观。
手工引用计数
继承自NSObject的成员变量指针，通常被假定是强引用关系(retained)或者弱引用(weak)。同样，属性如果没被类retained，应该注释为指派(assign)。一个特例是在MAC桌面软件中，以IBOutlets作为标签的成员变量默认是不会被类retained的。
当成员变量指向CoreFoundation、C++或者其它非Objective-C对象时，无论是强引用还是弱引用，都需要使用强弱引用标识符标明。CoreFoundation对象和其他非Objective-C对象需要显示的内存管理，即使是使用ARC或垃圾收集的时候。当weak修饰符不被允许使用的时候（例如clang编译器下的C++成员变量）需要注释代替。
注意：Objective-C对象中的C++对象的自动封装，默认情况下是不允许的，参见here。
强引用及弱引用注释的例子：
@interfaceMyDelegate:NSObject{
@private
IBOutletNSButton*_okButton;//normalNSControl;implicitlyweakonMaconly
AnObjcObject*_doohickey;//mydoohickey
__weakMyObjcParent*_parent;//sowecansendmsgsback(ownsme)
//non-NSObjectpointers...
__strongCWackyCPPClass*_wacky;//somecross-platformobject
__strongCFDictionaryRef*_dict;
}
@property(strong,nonatomic)NSString*doohickey;
@property(weak,nonatomic)NSString*parent;
@end
自动引用计数
对象所有权和生命周期中明确使用ARC，无需而外的注释。
Cocoa以及Objective-C特性
头文件中的成员变量应该为@private
在头文件中声明的成员变量应该声明为私有
指明指定的初始化器
注释并且明确指出你的类的指定的初始化器。
对于需要继承你的类的人来说，指定的初始化器十分重要。这样他们就可以只重写一个初始化器（可能是几个）来保证他们的子类的初始化器会被调用。这也有助于将来别人调试你的类时，理解初始化代码的工作流程。
重写指定的初始化器
当你写子类的时候，如果需要init...方法，记得重写父类的指定的初始化器。
如果没有重写父类的指定的初始化器，你的初始化器有时可能不会被调用，这会导致很微妙而且难以解决的bug。
初始化
不要在init方法中，将成员变量初始化为0或者nil，这是冗余的。
刚分配的对象，默认值都是0。除了isa指针（译者注：NSObject的isa指针，用于标识对象的类型）。所以不要在初始化器里面写一堆将成员初始化为0或者nil的代码。
避免使用+new
不要调用NSObject类的类方法new，也不要在子类重写。相反，你应该使用alloc和init方法来创建并初始化一个对象。
现代的Ojbective-C代码通过调用alloc和init方法来创建并且retain一个对象。由于类方法new很少被使用，这使得有关内存分配的代码审查更困难。
保持公有的API尽量简单
保持类简单，避免"kitchen-sink"（不知道怎么翻译，厨房水槽，大概是错综复杂的意思吧）式的API。不要公开不需要被公开的方法，用一个私有的分类来处理，而不要暴漏在头文件中。
与C++不同，Objective-C没有方法来区分公有的方法和私有的方法，所有的方法都是公有的（译者注：这取决于Objective-C运行时的方法调用的消息机制）。因此，除非客户端的代码期望使用某个方法，不要把这个方法放进公有的API中。这降低了你不希望被调用的方法被调用的可能性。这包括重写父类的方法。对于内部实现所需要的方法，在实现的文件中定义一个类别，而不是把它们放进公有的头文件中。
在Objective-C2.0之前，如果你在私有的@interface中声明了某个方法，但在@implementation中忘记定义了这个方法，编译器不会反对（这是因为你没有在其它的类别中实现这个私有的方法）。解决文案是将方法放进指定类别的@implemenation中。
如果你在使用Objective-C2.0，相反你应该使用类扩展来声明你的私有类别，例如：
这会保证如果声明的方法如果没有在@implementation中实现，会产生一个编译器警告。
再次说明，私有的方法其实不是私有的。你有时可能不小心重写了父类的私有方法，这很难调试。
通常，私有的方法应该有一个相当特殊的名字以防止子类无意地重写它们。Ojbective-C的类别是一种很好的方法来将一个大的@implementation拆分成更容易理解的小块。同时，类别可以为最适合的类添加新的、基于特定应用程序的功能。例如，当添加一个“middle
truncation”方法时，创建一个NSString的新类别并把方法放在里面，比创建任意的一个新类把方法放进里面要好得多。
#import与#include
#importOjbective-C/Objective-C++头文件，#includeC/C++头文件。
基于你所包括的头文件的编程语言，选择使用#import还是#include：
当包含一个使用Objective-C、Objective-C++的头文件时，使用#import。
当包含一个使用标准C、C++头文件时，使用#include。头文件应该提供自己的。
一些Ojbective-C的头文件缺少#define保护，只期望被使用#import的方式包含。由于Objective-C的头文件只会被Objective-C的源文件及头文件包含，广泛地使用#import是可以的。
文件中没有Objective-C的标准C、C++的头文件，可能会被普通的C、C++包含。既然标准的C、C++里面没有#import的用法，这些文件将被#include包含。Objective-C源文件中使用#include包含，意味着这些头文件会永远以相同的语义被包含。
这条规则帮助跨平台的项目中产生无意的错误。一个忘记使用#define保护的Mac开发者，在引用了新的C、C++头文件时，如果新的头文件使用#import被引用，在Mac上会没有问题。但在其它使用#include平台上可能会使构造失败。一致地在所有的平台上使用#include，意味着构造更可能一致地成功或者失败。这避免了文件只能在某些平台上使用的尴尬。
#import<Cocoa/Cocoa.h>
#include<CoreFoundation/CoreFoundation.h>
#import"GTMFoo.h"
#include"base/basictypes.h"
使用根框架
包含根框架而不是单独的文件。
当你试图从框架（如Cocoa或者Foundation）中包含单独的系统头文件时，实际上包含顶级根框架编译器要作更少的工作。根框架通常被预编译，并且加载得更快。另外记得使用#import而不是#include来包含Objective-C的框架。
#import<Foundation/Foundation.h>
//good
#import<Foundation/NSArray.h>
//avoid
#import<Foundation/NSString.h>
...
创建对象时尽量使用autorelease
当创建临时对象时，在同一行使用autolease，而不是在同一个方法的后面语句中使用一个单独的release。
尽管运行效率会差一点，这避免了意外地删除了release或者插入return语句而产生内存泄露的可能。
//AVOID(unlessyouhaveacompellingperformancereason)
MyController*controller=[[MyControlleralloc]init];
//...codeherethatmightreturn...
[controllerrelease];
//BETTER
MyController*controller=[[[MyControlleralloc]init]autorelease];
Autolease之后retain
给对象赋值时遵守autorelease之后retain的模式。
当给一个变量赋值新的对象时，必须先释放掉旧的对象以避免内存泄露。有一些正确的方法来处理它。我们选择autorelease之后retain的方法因为事实证明它更少地出错。注意大的循环会填满autorelease
pool，并且可能效率上会差一点，但这点折衷我们认为是可以接受的。
-(void)setFoo:(GMFoo*)aFoo{
[_fooautorelease];//Won'tdeallocif|_foo|==|aFoo|
_foo=[aFooretain];
}
在init和dealloc中避免使用存取方法
实例子类在init和dealloc方法执行的期间，可能会处于不确定的状态，所以应尽量避免在这些方法中使用存取方法。
子类还没有被初始化或已经释放时，存取方法可能不可靠。无论何时，直接在方法中分配和释放变量，而不是依靠存取方法。
-(id)init{
self=[superinit];
if(self){
_bar=[[NSMutableStringalloc]init];//good
}
returnself;
}
-(void)dealloc{
[_barrelease];//good
[superdealloc];
}
-(id)init{
self=[superinit];
if(self){
self.bar=[NSMutableStringstring];//avoid
}
returnself;
}
-(void)dealloc{
self.bar=nil;//avoid
[superdealloc];
}
Dealloc中应该按声明的顺序处理成员变量
dealloc中对象被释放的顺序应该与他们在@interface中声明的顺序一致，这有助于代码审查。
代码审查者在审查新的或者修改过的dealloc实现时，需要保证每个retained的对象都得到了释放。
为了简单的审查dealloc，对象被释放的顺序应该与他们在@interface中声明的顺序一致。如果dealloc调用了其它方法释放成员变量，注释这个方法处理了哪些成员变量的释放。
Setters中对NSString进行copy
接受NSString作为参数的setter，应该copy它所接受的字符串。
永远不要仅仅retain一个字符串。这避免了调用者在你不知道的情况下对字符串作出了修改。不要作出那样的假设：你接受的对象是一个NSString对象而不是NSMutableString对象。
避免抛出异常
不要抛出Objective-C异常，但准备从第三方的调用或者系统调用捕捉异常。
我们确实在编译时允许-fobjc-exceptions（主要我们得到了使用@synchronized的好处），但我们不使用@throw。当正确地使用第三方的代码时，使用@try、@catch、和@finally是允许的。如果你确实使用了异常，请注释你期望什么方法抛出异常。
不要使用NS_DURING,NS_HANDLER,NS_ENDHANDLER,NS_VALUERETURN
和NS_VOIDRETURN
这些宏，除非你写的代码需要在MacOSX10.2或者之前的操作系统中运行。
注意：当使用Objective-C++写基于栈的对象的代码时，如果抛出Objective-C异常，对象不会被清理。例如：
classexceptiontest{
public:
exceptiontest(){NSLog(@"Created");}
~exceptiontest(){NSLog(@"Destroyed");}
};
voidfoo(){
exceptiontesta;
NSException*exception=[NSExceptionexceptionWithName:@"foo"
reason:@"bar"
userInfo:nil];
@throwexception;
}
intmain(intargc,char*argv[]){
GMAutoreleasePoolpool;
@try{
foo();
}
@catch(NSException*ex){
NSLog(@"exceptionraised");
}
return0;
}
会输出：
2006-09-2812:34:29.244exceptiontest[23661]Created
2006-09-2812:34:29.244exceptiontest[23661]exceptionraised
注意：这里析构函数从未被调用。这主要会影响基于栈的对象如shared_ptr、linked_ptr和所有你可能使用的STL对象。你永远不应该重新抛出Objective-C异常，也不应该在@try,
@catch,@finally语句块中使用基于栈的C++对象。
nil的检查
nil检查只用于逻辑流的判断。
使用nil的检查来检查应用程序的逻辑，而不是避免崩溃。Objective-C运行时会处理向一个nil的对象发送消息的情况。如果方法没有返回值，就没关系。如果有返回值，可能由于运行时架构、返回值类型以及OS
X版本的不同而不同，参见Apple'sdocumentation。
注意，这与检查C/C++的指针是否为NULL非常不同，运行时不会检查空的情况，并导致你的应用程序崩溃。你仍然需要保证你不会对一个C/C++的空指针解引用。
BOOL陷阱
将常规整形转换成BOOL时要小心，不要直接将BOOL值与YES进行比较。
Ojbective-C中定义BOOL为无符号字符型，这意味着BOOL类型可以有不同于YES(1)或者NO(0）的值。不要直接把整形转换成BOOL。常见的错误包括将数组的大小、指针值及位运算的结果直接转换成BOOL，这取决于整型结果的最后一个字节，可能产生一个NO的值。当转换整形至BOOL时，使用三目操作符来返回YES或者NO。(译者注：读者可以试一下任意的256的整数的转换结果，如256、512...)
你可以安全在BOOL,_Bool以及bool之间转换（参见C++
Std4.7.4,4.12andC99Std6.3.1.2）。你不能安全在BOOL以及Boolean之间转换，因此请把Boolean当作一个普通的整形，就像我产在上面讨论的那样。Objective-C的方法签名中，只使用BOOL。
对BOOL使用逻辑运算符（&&,||
和!）是合法的，返回值也可以安全地转换成BOOL，不需要使用三目操作符。
-(BOOL)isBold{
return[selffontTraits]&NSFontBoldTrait;
}
-(BOOL)isValid{
return[selfstringValue];
}
-(BOOL)isBold{
return([selffontTraits]&NSFontBoldTrait)?YES:NO;
}
-(BOOL)isValid{
return[selfstringValue]!=nil;
}
-(BOOL)isEnabled{
return[selfisValid]&&[selfisBold];
}
同样的，不要直接比较BOOL变量与YES/NO。不仅仅这影响可读性，结果可能与你想的不同。
BOOLgreat=[fooisGreat];
if(great==YES)
//...begreat!
BOOLgreat=[fooisGreat];
if(great)
//...begreat!
属性
使用点引用语法需要Objective-C2.0的支持，这意味着你的代码只能运行于iPhone或者Mac
OSX10.5(Leopard)及以后的版本。点引用只允许访问声明的属性。
命名
属性所关联的成员变量的命名必须遵守以下划线作为前缀的规则。属性的名字应该与成员变量去掉下划线前缀的名字一模一样。@property和左括号之间可选的空格可以忽略，如下例所示：
@interfaceMyClass:NSObject
@property(copy,nonatomic)NSString*name;
@end
@implementationMyClass
//Nocoderequiredforauto-synthesis,elseuse:
//
@synthesizename=_name;
@end
位置
类接口中的属性的声明必须紧跟着成员变量语句块。属性的定义必须在@implementation的类定义的最上方。他们的缩进与包含他们的@interface以及@implementation语句一样。
@interfaceMyClass:NSObject{
@private
NSString*_name;
}
@property(copy,nonatomic)NSString*name;
@end
@implementationMyClass
@synthesizename=_name;
-(id)init{
...
}
@end
NSString使用copy特性
NSString属性应该永远被声明为copy特性。
这从逻辑上遵守了NSString的setter必须使用copy而不是retain。
原子性
一定要注意属性的开销。所有synthesize的setter和getter都是原子的。这会给每个get或者set带来一定的同步开销。显示将你的属性声明为nonatomic除非你需要原子操作。
点引用
点引用是地道的Objective-C2.0的风格。它被使用于简单的属性set、get操作，但对象的其它行为不应该使用它。
没有实例变量的接口
没有声明任何实例变量的接口要省略括号空集。
自动合成实例变量
首选使用自动合成的实例变量。必须支持早期版本的编译器工具（4.3或更早版本的Xcode或用GCC编译时）或正在使用从协议继承的属性的代码应该直接用@synthesize合成属性。
//Headerfile
@protocolThingy
@property(nonatomic,copy)NSString*widgetName;
@end
@interfaceFoo:NSObject<Thingy>
//Aguywalksintoabar.
@property(nonatomic,copy)NSString*bar;
@end
//Implementationfile
@interfaceFoo()
@property(nonatomic,retain)NSArray*baz;
@end
@implementationFoo
@synthesizewidgetName=_widgetName;
@end
自动合成实例变量采用下划线前缀加属性的名称的形式，所以需要变量命名风格一致。如果属性名称是不寻常的，或者是其他原因无法使用自动合成实例变量，使用@synthesize合成的，要明确指定的实例变量名（@
synthesize默认情况下不加下划线前缀）。
自动引用计数
如果使用Xcode4.2或者更新的版本，并且运行于64位Mac
OSX10.7或者iOS5.0或者更高版本，优先选用ARC。手动引用计数。早期环境的手工引用计数不适用于归零弱指针。
使用ARC的类应该直接包含预定义宏防止编译器使用手动引用计数。
所有权标识__unsafe_unretained和__weak应该被优先使用。__strong变量默认不需要显示的标明。而另一方面，属性应该总是指定strong关键字而不要依赖编译器默认。
使用ARC编译的文件需要用预定义宏标识，防止编译成非ARC。请参见下面的代码片段的详细信息。
示例是ARC风格的实现文件。请注意，在使用ARC时，在@implementation声明实例变量是允许的。
#if!defined(__has_feature)||!__has_feature(objc_arc)
#error"ThisfilerequiresARCsupport."
#endif
#import"Foo.h"
@implementationFoo{
Bar*__weak_bar;
Baz*__unsafe_unretained_baz;
}
//...
@end
NSNumber常量
使用Xcode4.4或更高版本的编译器时，允许使用NSNumber
literals。但是请注意，这将限制你的代码可移植性。
NSNumber常量的使用类似Objective-C字符串常量的使用。在必要时需要封装。使用NSNumber常量的代码可以部署在任何iOS/MacOS系统。
NSNumber*fortyTwo=@42;
NSNumber*piOverTwo=@(M_PI/2);
enum{
kMyEnum=2;
};
NSNumber*myEnum=@(kMyEnum);
Cocoa模式
委托模式
委托对象不应该被retained。
实现委托模式的类应该：
拥有一个名为delegate_的成员变量来引用委托。
因此，访问器方法应该名为delegate和setDelegate:。
_delegdelegate_对象不应该被retained。
模型-视图-控制器
分离模型与视图。分离控制器与视图、模型。回调API使用@protocol。
模型与视图分离：不要假设模型或者数据源的表示方法。保持数据源与表示层之间的接口抽象。视图不需要了解模型的逻辑（主要的规则是问问你自己，对于数据源的一个实例，有没有可能有多种不同状态的表示方法）。
控制器与模型、视图分离：不要把所有的“领域逻辑”放进跟视图有关的类中。这命名得代码非常难以重用。使用控制器来写这些代码，但保证控制器不需要了解太多表示层的逻辑。
使用@protocol来定义回调API，如果不是所有的方法都必须实现，使用@optional（例外：当使用Objective-C1.0，@optional不可用，因此请使用类别来定义“非正式的协议”）。
Objective-C是一种动态的面向对象的语言，它是C的扩展。它被设计成具有易读易用的，支持复杂的面向对象设计的编程语言。它是Mac
OSX以及iPhone的主要开发语言。
Cocoa是MacOSX的主要的应用程序框架。它由一组支持MacOSX全部特性的，并可用于快速开发的Objective-C类构成。
苹果公司已经撰写了非常全面的Objective-C编码指南。Google也为C++写了类型的编码指南。这个Objective-C指南是苹果和Google最佳实践的结合。因此，在阅读本指南之前，请确定你已经读过以下内容：
注意：所有在Google的C++编码指南中所禁止的事情，如未有特殊提及，也同样不能在Objective-C++中使用。
本文档的目的在于为所有的MacOSX的代码提供编程指南及最佳实践。许多指南是在实际的项目及小组中经过长期的演进及验证的。Google开发的开源项目遵从本指南的要求。
Google已经发布了
请注意，本指南不是Objective-C的教程。我们假定读者已经对Objective-C非常熟悉。如果你刚刚接触Objective-C或者需要提高，请阅读Programming
withObjective-C。
例子
一个例子顶上一千句话，我们就从这样的一个例子开始，来感受一下编码的风格、空格以及命名等等。
一个头文件的例子，展示了在@interface声明中如何进行正确的注释以及空格。
#import<Foundation/Foundation.h>
//AsampleclassdemonstratinggoodObjective-Cstyle.Allinterfaces,
//categories,andprotocols(read:alltop-leveldeclarationsinaheader)
//MUSTbecommented.Commentsmustalsobeadjacenttotheobjectthey're
//documenting.
//
//(noblanklinebetweenthiscommentandtheinterface)
@interfaceFoo:NSObject{
@private
NSString*_bar;
NSString*_bam;
}
//ReturnsanautoreleasedinstanceofFoo.See-initWithBar:fordetails
//about|bar|.
+(id)fooWithBar:(NSString*)bar;
//Designatedinitializer.|bar|isathingthatrepresentsathingthat
//doesathing.
-(id)initWithBar:(NSString*)bar;
//Getsandsets|_bar|.
-(NSString*)bar;
-(void)setBar:(NSString*)bar;
//Doessomeworkwith|blah|andreturnsYESiftheworkwascompleted
//successfully,andNOotherwise.
-(BOOL)doWorkWithBlah:(NSString*)blah;
@end
一个实现文件的例子，展示了@implementation部分如何进行正确的注释、空格。同时也包括了基于引用实现的一些重要方法，如getters、setters、init以及dealloc。
#import"Foo.h"
@implementationFoo
+(id)fooWithBar:(NSString*)bar{
return[[[selfalloc]initWithBar:bar]autorelease];
}
//Mustalwaysoverridesuper'sdesignatedinitializer.
-(id)init{
return[selfinitWithBar:nil];
}
-(id)initWithBar:(NSString*)bar{
if((self=[superinit])){
_bar=[barcopy];
_bam=[[NSStringalloc]initWithFormat:@"hi%d",3];
}
returnself;
}
-(void)dealloc{
[_barrelease];
[_bamrelease];
[superdealloc];
}
-(NSString*)bar{
return_bar;
}
-(void)setBar:(NSString*)bar{
[_barautorelease];
_bar=[barcopy];
}
-(BOOL)doWorkWithBlah:(NSString*)blah{
//...
returnNO;
}
@end
@interface,@implementation,
和@end前后的空白行是可以选的。如果@interface声明了实例变量，在右括号后必须有空白行。
除非接口或实现非常短，比如声明了一撮私有方法或bridge类，增加空白行通常可以提高可读性。
空格与格式
空格与制表符
只使用空格，每次缩进两个空格。
我们使用空格进行缩进。不要在代码中使用制表符。你应该将你的文本编辑器设置成自动将制表符替换成空格。
行宽
代码中的每行最多有80个字符。
即使Objective-C比C++更加冗长，为了保证本指南的可操作性，我们决定保持每行宽度为80列。这比你想的要简单。
我们意识到这条规则是有争议的，但很多已经存在的代码坚持了本规则，因此我们觉得保证一致性更重要。
通过设置Xcode>Preferences>TextEditing>Showpageguide.，来使越界更容易被发现。
方法声明与定义
-或者+与返回类型之间，需要有空格。参数列表中，只有参数之间有空格。
方法应该像这样：
-(void)doSomethingWithString:(NSString*)theString{
...
}
星号前的空格是可选的。当写新的代码时，要与原的代码一致。
如果一行有非常多的参数，更好的方式是将每个参数单独拆成一行。如果使用多行，将每个参数前的冒号对齐。
-(void)doSomethingWith:(GTMFoo*)theFoo
rect:(NSRect)theRect
interval:(float)theInterval{...
}
当第一个关键字比其它的短时，保证下一行至少有4个空格的缩进。这样可以使关键字垂直对齐，而不是使用冒号对齐：
-(void)short:(GTMFoo*)theFoo
longKeyword:(NSRect)theRect
evenLongerKeyword:(float)theInterval
error:(NSError**)theError{...
}
方法调用
方法定义的格式与方法声明的格式非常相似。当格式的风格有多种选择时，新的代码要与已经存在的代码保持一致。
方法调用时，所有参数应该在同一行。
[myObjectdoFooWith:arg1name:arg2error:arg3];
或者每行一个参数，以冒号对齐：
[myObjectdoFooWith:arg1
name:arg2
error:arg3];
不要使用下面的缩进风格：
[myObjectdoFooWith:arg1name:arg2//somelineswith>1arg
error:arg3];
[myObjectdoFooWith:arg1
name:arg2error:arg3];
[myObjectdoFooWith:arg1
name:arg2//aligningkeywordsinsteadofcolons
error:arg3];
方法定义与方法声明一样，当关键字的长度不足以以冒号对齐时，下一行都要以四个空格进行缩进。
[myObjshort:arg1
longKeyword:arg2
evenLongerKeyword:arg3
error:arg4];
调用包含内联
@public与@private
@public以及@private访问标识符应该以一个空格缩进。
与C++中的public,private,以及protected非常相似。
@interfaceMyClass:NSObject{@public
...
@private
...
}
@end
异常
每个@标签应该有独立的一行，在@与左大括号({)之间需要有一个空格。@catch与被捕捉到的异常对象的声明之间也要有一个空格。
如果你必须使用Objective-C的异常，按下面的格式进行编码代码。然后，请参见Avoid
ThrowingExceptions来了解不应该使用异常的原因。
@try{foo();
}
@catch(NSException*ex){bar(ex);
}
@finally{baz();
}
协议
尖括号所包括的协议名称与前面的类型标识之间不应该有空格。
这条规则也同样适用于类声明、成员变量以及方法声明。例如：
@interfaceMyProtocoledClass:NSObject<NSWindowDelegate>{@private
id<MyFancyDelegate>_delegate;
}
-(void)setDelegate:(id<MyFancyDelegate>)aDelegate;
@end
Blocks
Block是创建callback回调时首选的target-selector目标选择器模式，因为它使代码更易于阅读。Block里面的代码块应缩进4个空格。
下面是一些相应的风格规则，取决于block有多长：
如果block能一行写完，不要分行。
如果有分行，右大括号必须与block声明的那一行的第一个字符对齐。
block内的代码必须缩进4个空格。
如果block代码很多，比如，超过20行，建议移到外面用一个本地变量保存。
如果block没有参数，在字符^{之间不要有空格，如果block有参数，字符^(之间不要有空格，但字符){之间有一个空格。
包含内联block的调用可以让其代码段左对齐四空间缩进。这有助于理解包含多个内嵌块的调用。
两个空间内缩进块也可以，但应该只用于保持与项目其他代码风格一致性时。
//Theentireblockfitsononeline.
[operationsetCompletionBlock:^{[selfonOperationDone];}];
//Theblockcanbeputonanewline,indentedfourspaces,withthe
//closingbracealignedwiththefirstcharacterofthelineonwhich
//blockwasdeclared.
[operationsetCompletionBlock:^{
[self.delegatenewDataAvailable];
}];
//UsingablockwithaCAPIfollowsthesamealignmentandspacing
//rulesaswithObjective-C.
dispatch_async(_fileIOQueue,^{
NSString*path=[selfsessionFilePath];
if(path){
//...
}
});
//Anexamplewheretheparameterwrapsandtheblockdeclarationfits
//onthesameline.Notethespacingof|^(SessionWindow*window){|
//comparedto|^{|above.
[[SessionServicesharedService]
loadWindowWithCompletionBlock:^(SessionWindow*window){
if(window){
[selfwindowDidLoad:window];
}else{
[selferrorLoadingWindow];
}
}];
//Anexamplewheretheparameterwrapsandtheblockdeclarationdoes
//notfitonthesamelineasthename.
[[SessionServicesharedService]
loadWindowWithCompletionBlock:
^(SessionWindow*window){
if(window){
[selfwindowDidLoad:window];
}else{
[selferrorLoadingWindow];
}
}];
//Largeblockscanbedeclaredout-of-line.
void(^largeBlock)(void)=^{
//...
};
[_operationQueueaddOperationWithBlock:largeBlock];
//Anexamplewithmultipleinlinedblocksinoneinvocation.
[myObjectdoSomethingWith:arg1
firstBlock:^(Foo*a){
//...
}
secondBlock:^(Bar*b){
//...
}];
容器常量
使用Xcode4.4或更高版本的的项目，鼓励使用容器常量。如果被分成了多行，其内容需两个空白字符缩进。
如果集合内容只有一行，开始中括号[之后和结束中括号]之前需要一个空格。
NSArray*array=@[[foodescription],@"AnotherString",[bardescription]];
NSDictionary*dict=@{NSForegroundColorAttributeName:[NSColorredColor]};
而不是:
NSArray*array=@[[foodescription],[bardescription]];
NSDictionary*dict=@{NSForegroundColorAttributeName:[NSColorredColor]};
如果集合跨越超过一行，左中括号[单独位于声明的那一行，内容缩进两个空格，右括号位于新行并与声明左中括号的行开头对齐。
NSArray*array=@[
@"This",
@"is",
@"an",
@"array"
];
NSDictionary*dictionary=@{
NSFontAttributeName:[NSFontfontWithName:@"Helvetica-Bold"size:12],
NSForegroundColorAttributeName:fontColor
};
对于字典常量，冒号前后应该有一个空格（值是否对齐是可选的）
NSDictionary*option1=@{
NSFontAttributeName:[NSFontfontWithName:@"Helvetica-Bold"size:12],
NSForegroundColorAttributeName:fontColor
};
NSDictionary*option2=@{
NSFontAttributeName:[NSFontfontWithName:@"Arial"size:12],
NSForegroundColorAttributeName:fontColor
};
如下是错误的：
//Thereshouldbeaspacebeforethecolon.
NSDictionary*wrong=@{
AKey:@"b",
BLongerKey:@"c",
};
//Theitemsshouldeachbeonanewline,ortheentireexpression
//shouldfitononeline.
NSDictionary*alsoWrong=@{AKey:@"a",
BLongerKey:@"b"};
//Thereshouldbenovariablespacebeforethecolon,onlyafter.
NSDictionary*stillWrong=@{
AKey:@"b",
BLongerKey:@"c",
};
命名
对于可维护的代码，命名规则非常重要。Objective-C的方法名往往十分长，但代码块读起来就像散文一样，不需要太多的注释修饰。
当编写纯Objective-C代码时，我们基本遵守标准的Objective-C
namingrules，这些命名规则可能与C++风格指南中的大相径庭。例如，Google的C++风格指南中推荐使用下划线分隔的单词作为变量名，而(苹果的)风格指南则使用camel命名法，这在Objective-C社区中非常普遍。
任何的类、分类、方法以及变量的名字中都使用全大写缩写。这遵守了苹果的标准命名方式，如URL、TIFF以及EXIF。
当编写Objective-C++代码时，事情就不这么简单了。许多的项目需要实现跨平台的C++代码，并与Objective-C以及Cocoa混合编写。或者以C++作为后端，Cocoa作为前端。这就导致了两种命名方式直接不统一。
我们的解决方案是：编码风格取决于方法/函数以哪种语言实现。如果在一个@implementation语句块中，就使用Objective-C的风格。如果实现一个C++的类，请使用C++的风格。这避免了成员变量与局部变量使用混合的命名风格，这会严重地影响可读性。
文件名
文件名应该反映了它实现了什么类。遵守你的项目的惯例。
文件的扩展名应该如下：
| .h | C/C++/Objective-C头文件 |
| .m | Objective-C实现文件 |
| .mm | Objective-C++实现文件 |
| .cc | PureC++实现文件 |
| .c | C实现文件 |
GTMNSString+Utils.h或GTMNSTextView+Autocomplete.h。
Objective-C++
当编写源代码时，Ojbective-C++应该采用你正在实现的方法/函数的风格。
为了最小化Cocoa/Objective-C与C++之间的命名风格的冲突，按照下面方法实现的风格编写代码。在实现@implementation语句块时，使用Objective-C的命名规则；如果实现一个C++的类，就使用C++命名规则。
//file:cross_platform_header.h
classCrossPlatformAPI{public:
...
intDoSomethingPlatformSpecific();//imploneachplatform
private:
intan_instance_var_;
};
//file:mac_implementation.mm
#include"cross_platform_header.h"
//AtypicalObjective-Cclass,usingObjective-Cnaming.
@interfaceMyDelegate:NSObject{@private
int_instanceVar;
CrossPlatformAPI*_backEndObject;
}
-(void)respondToSomething:(id)something;
@end
@implementationMyDelegate
-(void)respondToSomething:(id)something{//bridgefromCocoathroughourC++backend
_instanceVar=_backEndObject->DoSomethingPlatformSpecific();
NSString*tempString=[NSStringstringWithInt:_instanceVar];
NSLog(@"%@",tempString);
}
@end
//Theplatform-specificimplementationoftheC++class,using
//C++naming.
intCrossPlatformAPI::DoSomethingPlatformSpecific(){NSString*temp_string=[NSStringstringWithInt:an_instance_var_];
NSLog(@"%@",temp_string);
return[temp_stringintValue];
}
类名
类名、分类名、协议名应该以大写字母开始，并混合小写字母来分隔单词。(Camel命名法)
应用程序级的代码，应该尽量避免不必要的前缀。为每个类都添加前缀不会提高任何的可读性。当设计跨不同应用程序的代码时，应该使用前缀，例如：GTMSendMessage。
类别名
类别名应该有两三个字母的前缀以表示类别是项目的一部分或者该类别是通用的。类别应该包含它所扩展的类的名字。
例如，录我们要创建一个NSString的类别以解析时，我们将把类别放在一个名为GTMNSString+Parsing.h的文件中。类别名本身的名字是GTMStringParsingAdditions（是的，我们知道类别名和文件名不一样，但是这个文件中可能存在多个不同的与解析有关类别）。类别中的方法应该以gtm_myCategoryMethodOnAString为前缀以避免命名冲突，因为Objective-C只有一个命名空间。如果代码不会被分享并且不会被运行在不同的地址空间中，方法名字就不那么重要。
类名与包含类别名的括号之间，应该以一个空格分隔。
//Extendingaframeworkclass:
@interfaceNSString(GTMStringParsingAdditions)
-(NSString*)gtm_foobarString;
@end
//Makingyourmethodsandpropertiesprivate:
@interfaceFoobarViewController()
@property(nonatomic,retain)NSView*dongleView;
-(void)performLayout;
@end
Objective-C方法名
方法名应该以小写字母开头，并混合大小写（Camel命名法）。每个命名的参数也应该以小写字母开头。
方法名应该读起来就像句子，这表示你应该选择与方法名连在一起读起来通顺的参数名。(例如，convertPoint:fromRect:orreplaceCharactersInRange:withString:)参见Apple's
GuidetoNamingMethods。
访问器方法应该与他们getting的的成员变量的名字一样，但不应该以get作为前缀。例如：
-(id)getDelegate;//AVOID
-(id)delegate;//GOOD
这仅限于Objective-C的方法名。C++的方法与函数的命名规则应该遵从C++风格指南中的规则。
变量名
变量名应该以小写字母开头，并混合大小写。类的成员变量应该以下划线作为前缀。例如：myLocalVariable,_myInstanceVariable。
常用变量名
对于静态的类别，如int以及指针等，不要使用匈牙利命名法。要为变量起一个描述性的名字。不要担心浪费列宽，因为让新的代码阅读者立即理解你的代码更重要。例如：
intw;
intnerr;
intnCompConns;
tix=[[NSMutableArrayalloc]init];
obj=[someObjectobject];
p=[networkport];
intnumErrors;
intnumCompletedConnections;
tickets=[[NSMutableArrayalloc]init];
userInfo=[someObjectobject];
port=[networkport];
成员变量
成员变量应该混合大小写，并以下划线作为前缀，如_usernameTextField。然而，由于历史惯例是将下划线作名称后缀。项目可能为了保持一致性而继续使用下划线后缀。建议你放弃使用旧的风格，除非这样会导致一个类的风格不一致性。
常量
常量名（如宏、枚举、静态局部变量等）应该以小写字母k开头，使用混合大小写的格式来分隔单词，如：
constintkNumberOfFiles=12;
NSString*constkUserKey=@"kUserKey";
enumDisplayTinge{kDisplayTingeGreen=1,
kDisplayTingeBlue=2
};
因为Objective-C没有提供命名空间，全局范围内的常量应该有一个适当的前缀来减小命名冲突，典型的类似kClassNameFoo。
注释
虽然写起来很痛苦，但注释是保证代码可读性的关键。下面的规则给出了你应该什么时候、在哪进行注释。记住：尽量注释很重要，但最好的代码应该自成文档。与其给类型及变量起一个晦涩难懂的名字，再为它写注释，不如直接起一个有意义的名字。
当你写注释的时候，记得你在给你的听众写，即下一个需要阅读你的代码的。大方一点，下一个读代码的人可能就是你！
记住所有C++风格指南里的规则在这里也同样适用，不同的地方会在下面指出。
文件注释
以版权信息作为文件头部，开始每一个文件，后接文件内容的描述。
每个文件应该按顺序包括如下内容：
版权信息声明（如：Copyright2008GoogleInc.）授权样版。选择一个合适的项目所使用的授权样板（例如，Apache2.0,BSD,LGPL,GPL）。
对文件内容必要的基本描述。
如果你对其他人的原始代码作出重大的修改，请把你的名字添加到作者里面。当另外一个代码贡献者对文件有问题时，他需要知道怎么联系你，这十分有用。
声明注释
每个接口、类别以及协议应该注释，以描述它的目的及作用。
//AdelegateforNSApplicationtohandlenotificationsaboutapp
//launchandshutdown.Ownedbythemainappcontroller.
@interfaceMyAppDelegate:NSObject{...
}
@end
如果你已经在文件头部详细描述了接口，可以直接说明“完整的描述请参见文件头部”，但是一定要有这部分注释。
另外，公共接口的每个方法，都应该有注释来解释它的作用、参数、返回值以及其它影响。
为类的线程安全性作注释，如果有的话。如果类的实例可以被多个线程访问，记得注释多线程条件下的使用规则。
实现注释
使用竖线|来引用注释中的变量名及符号名而不是使用引号。
这会避免二义性，尤其是当符号是一个常用词汇，这使用语句读起来很糟糕。例如，对于符号"count"：
//Sometimesweneed|count|tobelessthanzero.
或者当引用已经包含引号的符号：
//Remembertocall|StringWithoutSpaces("foobarbaz")|对象所有权
当与Objective-C最通常的做法不同时，尽量使用指针的所有权模型尽量直观。
手工引用计数
继承自NSObject的成员变量指针，通常被假定是强引用关系(retained)或者弱引用(weak)。同样，属性如果没被类retained，应该注释为指派(assign)。一个特例是在MAC桌面软件中，以IBOutlets作为标签的成员变量默认是不会被类retained的。
当成员变量指向CoreFoundation、C++或者其它非Objective-C对象时，无论是强引用还是弱引用，都需要使用强弱引用标识符标明。CoreFoundation对象和其他非Objective-C对象需要显示的内存管理，即使是使用ARC或垃圾收集的时候。当weak修饰符不被允许使用的时候（例如clang编译器下的C++成员变量）需要注释代替。
注意：Objective-C对象中的C++对象的自动封装，默认情况下是不允许的，参见
强引用及弱引用注释的例子：
@interfaceMyDelegate:NSObject{
@private
IBOutletNSButton*_okButton;//normalNSControl;implicitlyweakonMaconly
AnObjcObject*_doohickey;//mydoohickey
__weakMyObjcParent*_parent;//sowecansendmsgsback(ownsme)
//non-NSObjectpointers...
__strongCWackyCPPClass*_wacky;//somecross-platformobject
__strongCFDictionaryRef*_dict;
}
@property(strong,nonatomic)NSString*doohickey;
@property(weak,nonatomic)NSString*parent;
@end
自动引用计数
对象所有权和生命周期中明确使用ARC，无需而外的注释。
Cocoa以及Objective-C特性
头文件中的成员变量应该为@private
在头文件中声明的成员变量应该声明为私有
@interfaceMyClass:NSObject{@private
id_myInstanceVariable;
}
//publicaccessors,settertakesownership
-(id)myInstanceVariable;
-(void)setMyInstanceVariable:(id)theVar;
@end
指明指定的初始化器
注释并且明确指出你的类的指定的初始化器。
对于需要继承你的类的人来说，指定的初始化器十分重要。这样他们就可以只重写一个初始化器（可能是几个）来保证他们的子类的初始化器会被调用。这也有助于将来别人调试你的类时，理解初始化代码的工作流程。
重写指定的初始化器
当你写子类的时候，如果需要init...方法，记得重写父类的指定的初始化器。
如果没有重写父类的指定的初始化器，你的初始化器有时可能不会被调用，这会导致很微妙而且难以解决的bug。
初始化
不要在init方法中，将成员变量初始化为0或者nil，这是冗余的。
刚分配的对象，默认值都是0。除了isa指针（译者注：NSObject的isa指针，用于标识对象的类型）。所以不要在初始化器里面写一堆将成员初始化为0或者nil的代码。
避免使用+new
不要调用NSObject类的类方法new，也不要在子类重写。相反，你应该使用alloc和init方法来创建并初始化一个对象。
现代的Ojbective-C代码通过调用alloc和init方法来创建并且retain一个对象。由于类方法new很少被使用，这使得有关内存分配的代码审查更困难。
保持公有的API尽量简单
保持类简单，避免"kitchen-sink"（不知道怎么翻译，厨房水槽，大概是错综复杂的意思吧）式的API。不要公开不需要被公开的方法，用一个私有的分类来处理，而不要暴漏在头文件中。
与C++不同，Objective-C没有方法来区分公有的方法和私有的方法，所有的方法都是公有的（译者注：这取决于Objective-C运行时的方法调用的消息机制）。因此，除非客户端的代码期望使用某个方法，不要把这个方法放进公有的API中。这降低了你不希望被调用的方法被调用的可能性。这包括重写父类的方法。对于内部实现所需要的方法，在实现的文件中定义一个类别，而不是把它们放进公有的头文件中。
#import"GTMFoo.h"
@interfaceGTMFoo(PrivateDelegateHandling)
-(NSString*)doSomethingWithDelegate;//Declareprivatemethod
@end
@implementationGTMFoo(PrivateDelegateHandling)
...
-(NSString*)doSomethingWithDelegate{//Implementthismethod
}
...
@end
在Objective-C2.0之前，如果你在私有的@interface中声明了某个方法，但在@implementation中忘记定义了这个方法，编译器不会反对（这是因为你没有在其它的类别中实现这个私有的方法）。解决文案是将方法放进指定类别的@implemenation中。
如果你在使用Objective-C2.0，相反你应该使用类扩展来声明你的私有类别，例如：
@interfaceGMFoo(){...}这会保证如果声明的方法如果没有在@implementation中实现，会产生一个编译器警告。
再次说明，私有的方法其实不是私有的。你有时可能不小心重写了父类的私有方法，这很难调试。
通常，私有的方法应该有一个相当特殊的名字以防止子类无意地重写它们。Ojbective-C的类别是一种很好的方法来将一个大的@implementation拆分成更容易理解的小块。同时，类别可以为最适合的类添加新的、基于特定应用程序的功能。例如，当添加一个“middle
truncation”方法时，创建一个NSString的新类别并把方法放在里面，比创建任意的一个新类把方法放进里面要好得多。
#import与#include
#importOjbective-C/Objective-C++头文件，#includeC/C++头文件。
基于你所包括的头文件的编程语言，选择使用#import还是#include：
当包含一个使用Objective-C、Objective-C++的头文件时，使用#import。
当包含一个使用标准C、C++头文件时，使用#include。头文件应该提供自己的。
一些Ojbective-C的头文件缺少#define保护，只期望被使用#import的方式包含。由于Objective-C的头文件只会被Objective-C的源文件及头文件包含，广泛地使用#import是可以的。
文件中没有Objective-C的标准C、C++的头文件，可能会被普通的C、C++包含。既然标准的C、C++里面没有#import的用法，这些文件将被#include包含。Objective-C源文件中使用#include包含，意味着这些头文件会永远以相同的语义被包含。
这条规则帮助跨平台的项目中产生无意的错误。一个忘记使用#define保护的Mac开发者，在引用了新的C、C++头文件时，如果新的头文件使用#import被引用，在Mac上会没有问题。但在其它使用#include平台上可能会使构造失败。一致地在所有的平台上使用#include，意味着构造更可能一致地成功或者失败。这避免了文件只能在某些平台上使用的尴尬。
#import<Cocoa/Cocoa.h>
#include<CoreFoundation/CoreFoundation.h>
#import"GTMFoo.h"
#include"base/basictypes.h"
使用根框架
包含根框架而不是单独的文件。
当你试图从框架（如Cocoa或者Foundation）中包含单独的系统头文件时，实际上包含顶级根框架编译器要作更少的工作。根框架通常被预编译，并且加载得更快。另外记得使用#import而不是#include来包含Objective-C的框架。
#import<Foundation/Foundation.h>
//good
#import<Foundation/NSArray.h>
//avoid
#import<Foundation/NSString.h>
...
创建对象时尽量使用autorelease
当创建临时对象时，在同一行使用autolease，而不是在同一个方法的后面语句中使用一个单独的release。
尽管运行效率会差一点，这避免了意外地删除了release或者插入return语句而产生内存泄露的可能。
//AVOID(unlessyouhaveacompellingperformancereason)
MyController*controller=[[MyControlleralloc]init];
//...codeherethatmightreturn...
[controllerrelease];
//BETTER
MyController*controller=[[[MyControlleralloc]init]autorelease];
Autolease之后retain
给对象赋值时遵守autorelease之后retain的模式。
当给一个变量赋值新的对象时，必须先释放掉旧的对象以避免内存泄露。有一些正确的方法来处理它。我们选择autorelease之后retain的方法因为事实证明它更少地出错。注意大的循环会填满autorelease
pool，并且可能效率上会差一点，但这点折衷我们认为是可以接受的。
-(void)setFoo:(GMFoo*)aFoo{
[_fooautorelease];//Won'tdeallocif|_foo|==|aFoo|
_foo=[aFooretain];
}
在init和dealloc中避免使用存取方法
实例子类在init和dealloc方法执行的期间，可能会处于不确定的状态，所以应尽量避免在这些方法中使用存取方法。
子类还没有被初始化或已经释放时，存取方法可能不可靠。无论何时，直接在方法中分配和释放变量，而不是依靠存取方法。
-(id)init{
self=[superinit];
if(self){
_bar=[[NSMutableStringalloc]init];//good
}
returnself;
}
-(void)dealloc{
[_barrelease];//good
[superdealloc];
}
-(id)init{
self=[superinit];
if(self){
self.bar=[NSMutableStringstring];//avoid
}
returnself;
}
-(void)dealloc{
self.bar=nil;//avoid
[superdealloc];
}
Dealloc中应该按声明的顺序处理成员变量
dealloc中对象被释放的顺序应该与他们在@interface中声明的顺序一致，这有助于代码审查。
代码审查者在审查新的或者修改过的dealloc实现时，需要保证每个retained的对象都得到了释放。
为了简单的审查dealloc，对象被释放的顺序应该与他们在@interface中声明的顺序一致。如果dealloc调用了其它方法释放成员变量，注释这个方法处理了哪些成员变量的释放。
Setters中对NSString进行copy
接受NSString作为参数的setter，应该copy它所接受的字符串。
永远不要仅仅retain一个字符串。这避免了调用者在你不知道的情况下对字符串作出了修改。不要作出那样的假设：你接受的对象是一个NSString对象而不是NSMutableString对象。
-(void)setFoo:(NSString*)aFoo{[_fooautorelease];
_foo=[aFoocopy];
}
避免抛出异常
不要抛出Objective-C异常，但准备从第三方的调用或者系统调用捕捉异常。
我们确实在编译时允许-fobjc-exceptions（主要我们得到了使用@synchronized的好处），但我们不使用@throw。当正确地使用第三方的代码时，使用@try、@catch、和@finally是允许的。如果你确实使用了异常，请注释你期望什么方法抛出异常。
不要使用NS_DURING,NS_HANDLER,NS_ENDHANDLER,NS_VALUERETURN
和NS_VOIDRETURN
这些宏，除非你写的代码需要在MacOSX10.2或者之前的操作系统中运行。
注意：当使用Objective-C++写基于栈的对象的代码时，如果抛出Objective-C异常，对象不会被清理。例如：
classexceptiontest{
public:
exceptiontest(){NSLog(@"Created");}
~exceptiontest(){NSLog(@"Destroyed");}
};
voidfoo(){
exceptiontesta;
NSException*exception=[NSExceptionexceptionWithName:@"foo"
reason:@"bar"
userInfo:nil];
@throwexception;
}
intmain(intargc,char*argv[]){
GMAutoreleasePoolpool;
@try{
foo();
}
@catch(NSException*ex){
NSLog(@"exceptionraised");
}
return0;
}
会输出：
2006-09-2812:34:29.244exceptiontest[23661]Created
2006-09-2812:34:29.244exceptiontest[23661]exceptionraised
注意：这里析构函数从未被调用。这主要会影响基于栈的对象如shared_ptr、linked_ptr和所有你可能使用的STL对象。你永远不应该重新抛出Objective-C异常，也不应该在@try,
@catch,@finally语句块中使用基于栈的C++对象。
nil的检查
nil检查只用于逻辑流的判断。
使用nil的检查来检查应用程序的逻辑，而不是避免崩溃。Objective-C运行时会处理向一个nil的对象发送消息的情况。如果方法没有返回值，就没关系。如果有返回值，可能由于运行时架构、返回值类型以及OS
X版本的不同而不同，参见Apple'sdocumentation。
注意，这与检查C/C++的指针是否为NULL非常不同，运行时不会检查空的情况，并导致你的应用程序崩溃。你仍然需要保证你不会对一个C/C++的空指针解引用。
BOOL陷阱
将常规整形转换成BOOL时要小心，不要直接将BOOL值与YES进行比较。
Ojbective-C中定义BOOL为无符号字符型，这意味着BOOL类型可以有不同于YES(1)或者NO(0）的值。不要直接把整形转换成BOOL。常见的错误包括将数组的大小、指针值及位运算的结果直接转换成BOOL，这取决于整型结果的最后一个字节，可能产生一个NO的值。当转换整形至BOOL时，使用三目操作符来返回YES或者NO。(译者注：读者可以试一下任意的256的整数的转换结果，如256、512...)
你可以安全在BOOL,_Bool以及bool之间转换（参见C++
Std4.7.4,4.12andC99Std6.3.1.2）。你不能安全在BOOL以及Boolean之间转换，因此请把Boolean当作一个普通的整形，就像我产在上面讨论的那样。Objective-C的方法签名中，只使用BOOL。
对BOOL使用逻辑运算符（&&,||
和!）是合法的，返回值也可以安全地转换成BOOL，不需要使用三目操作符。
-(BOOL)isBold{
return[selffontTraits]&NSFontBoldTrait;
}
-(BOOL)isValid{
return[selfstringValue];
}
-(BOOL)isBold{
return([selffontTraits]&NSFontBoldTrait)?YES:NO;
}
-(BOOL)isValid{
return[selfstringValue]!=nil;
}
-(BOOL)isEnabled{
return[selfisValid]&&[selfisBold];
}
同样的，不要直接比较BOOL变量与YES/NO。不仅仅这影响可读性，结果可能与你想的不同。
BOOLgreat=[fooisGreat];
if(great==YES)
//...begreat!
BOOLgreat=[fooisGreat];
if(great)
//...begreat!
属性
使用点引用语法需要Objective-C2.0的支持，这意味着你的代码只能运行于iPhone或者Mac
OSX10.5(Leopard)及以后的版本。点引用只允许访问声明的属性。
命名
属性所关联的成员变量的命名必须遵守以下划线作为前缀的规则。属性的名字应该与成员变量去掉下划线前缀的名字一模一样。@property和左括号之间可选的空格可以忽略，如下例所示：
@interfaceMyClass:NSObject
@property(copy,nonatomic)NSString*name;
@end
@implementationMyClass
//Nocoderequiredforauto-synthesis,elseuse:
//
@synthesizename=_name;
@end
位置
类接口中的属性的声明必须紧跟着成员变量语句块。属性的定义必须在@implementation的类定义的最上方。他们的缩进与包含他们的@interface以及@implementation语句一样。
@interfaceMyClass:NSObject{
@private
NSString*_name;
}
@property(copy,nonatomic)NSString*name;
@end
@implementationMyClass
@synthesizename=_name;
-(id)init{
...
}
@end
NSString使用copy特性
NSString属性应该永远被声明为copy特性。
这从逻辑上遵守了NSString的setter必须使用copy而不是retain。
原子性
一定要注意属性的开销。所有synthesize的setter和getter都是原子的。这会给每个get或者set带来一定的同步开销。显示将你的属性声明为nonatomic除非你需要原子操作。
点引用
点引用是地道的Objective-C2.0的风格。它被使用于简单的属性set、get操作，但对象的其它行为不应该使用它。
NSString*oldName=myObject.name;
myObject.name=@"Alice";
NSArray*array=[[NSArrayarrayWithObject:@"hello"]retain];
NSUIntegernumberOfItems=array.count;//notaproperty
array.release;//notaproperty
没有实例变量的接口
没有声明任何实例变量的接口要省略括号空集。
@interfaceMyClass:NSObject
//Doesalotofstuff
-(void)fooBarBam;
@end
@interfaceMyClass:NSObject{}
//Doesalotofstuff
-(void)fooBarBam;
@end
自动合成实例变量
首选使用自动合成的实例变量。必须支持早期版本的编译器工具（4.3或更早版本的Xcode或用GCC编译时）或正在使用从协议继承的属性的代码应该直接用@synthesize合成属性。
//Headerfile
@protocolThingy
@property(nonatomic,copy)NSString*widgetName;
@end
@interfaceFoo:NSObject<Thingy>
//Aguywalksintoabar.
@property(nonatomic,copy)NSString*bar;
@end
//Implementationfile
@interfaceFoo()
@property(nonatomic,retain)NSArray*baz;
@end
@implementationFoo
@synthesizewidgetName=_widgetName;
@end
自动合成实例变量采用下划线前缀加属性的名称的形式，所以需要变量命名风格一致。如果属性名称是不寻常的，或者是其他原因无法使用自动合成实例变量，使用@synthesize合成的，要明确指定的实例变量名（@
synthesize默认情况下不加下划线前缀）。
自动引用计数
如果使用Xcode4.2或者更新的版本，并且运行于64位Mac
OSX10.7或者iOS5.0或者更高版本，优先选用ARC。手动引用计数。早期环境的手工引用计数不适用于归零弱指针。
使用ARC的类应该直接包含预定义宏防止编译器使用手动引用计数。
所有权标识__unsafe_unretained和__weak应该被优先使用。__strong变量默认不需要显示的标明。而另一方面，属性应该总是指定strong关键字而不要依赖编译器默认。
使用ARC编译的文件需要用预定义宏标识，防止编译成非ARC。请参见下面的代码片段的详细信息。
示例是ARC风格的实现文件。请注意，在使用ARC时，在@implementation声明实例变量是允许的。
#if!defined(__has_feature)||!__has_feature(objc_arc)
#error"ThisfilerequiresARCsupport."
#endif
#import"Foo.h"
@implementationFoo{
Bar*__weak_bar;
Baz*__unsafe_unretained_baz;
}
//...
@end
NSNumber常量
使用Xcode4.4或更高版本的编译器时，允许使用NSNumber
literals。但是请注意，这将限制你的代码可移植性。
NSNumber常量的使用类似Objective-C字符串常量的使用。在必要时需要封装。使用NSNumber常量的代码可以部署在任何iOS/MacOS系统。
NSNumber*fortyTwo=@42;
NSNumber*piOverTwo=@(M_PI/2);
enum{
kMyEnum=2;
};
NSNumber*myEnum=@(kMyEnum);
Cocoa模式
委托模式
委托对象不应该被retained。
实现委托模式的类应该：
拥有一个名为delegate_的成员变量来引用委托。
因此，访问器方法应该名为delegate和setDelegate:。
_delegdelegate_对象不应该被retained。
模型-视图-控制器
分离模型与视图。分离控制器与视图、模型。回调API使用@protocol。
模型与视图分离：不要假设模型或者数据源的表示方法。保持数据源与表示层之间的接口抽象。视图不需要了解模型的逻辑（主要的规则是问问你自己，对于数据源的一个实例，有没有可能有多种不同状态的表示方法）。
控制器与模型、视图分离：不要把所有的“领域逻辑”放进跟视图有关的类中。这命名得代码非常难以重用。使用控制器来写这些代码，但保证控制器不需要了解太多表示层的逻辑。
使用@protocol来定义回调API，如果不是所有的方法都必须实现，使用@optional（例外：当使用Objective-C1.0，@optional不可用，因此请使用类别来定义“非正式的协议”）。
内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理 
相关文章推荐
- Objective-C编码规范：26个方面解决iOS开发问题
- Objective-C编码规范：26个方面解决iOS开发问题
- 编码规范，objective-c编码规范
- Objective-C编码规范：26个方面解决iOS开发问题
- Objective-C编码规范
- Objective-C编码规范：26个方面解决iOS开发问题
- Objective-C 编码规范(一)
- Objective-C编码规范：26个方面解决iOS开发问题
- Objective-C编码规范：26个方面解决iOS开发问题
- iPhone开发入门守则：Objective-C编码规范--系列教程
- iOS开发Objective-C编码规范
- objective-c 编码规范(coding style)
- Objective-C开发编码规范
- 谷歌的编码规范，先收着
- Objective-C 编码规范
- iPhone开发入门守则：Objective-C编码规范--系列教程
- Objective-C编码规范：26个方面解决iOS开发问题
- 谷歌编码规范
- Objective-C开发编码规范
- Objective-C编码规范：26个方面解决iOS开发问题