團(tuán)隊的Objective-C代碼規(guī)范土居。本文主要內(nèi)容來自raywenderlich.com Objective-C編碼規(guī)范擦耀，并根據(jù)團(tuán)隊實際情況涩堤，進(jìn)行修改。
代碼組織
在函數(shù)分組和protocol/delegate實現(xiàn)中使用#pragma mark -來分類方法账磺，參考以下結(jié)構(gòu)：
#pragma mark - Lifecycle
- (instancetype)init {}
- (void)viewDidLoad {}
- (void)viewWillAppear:(BOOL)animated {}
- (void)viewDidAppear:(BOOL)animated {}
- (void)viewWillDisappear:(BOOL)animated {}
- (void)viewDidDisappear:(BOOL)animated {}
- (void)dealloc {}
#pragma mark - Custom Accessors
- (void)setCustomProperty:(id)value {}
- (id)customProperty {}
#pragma mark - IBActions/Event Response
- (IBAction)submitData:(id)sender {}
- (void)someButtonDidPressed:(UIButton*)button
#pragma mark - Protocol conformance
#pragma mark - UITextFieldDelegate
#pragma mark - UITableViewDataSource
#pragma mark - UITableViewDelegate
空格
- 縮進(jìn)使用4個空格痊远，確保在Xcode偏好設(shè)置來設(shè)置。(raywenderlich.com使用2個空格)
- 方法大括號和其他大括號(
if/else/switch/while等.)總是在同一行語句打開但在新行中關(guān)閉冒版。
應(yīng)該:
if (user.isHappy) {
//Do something
} else {
//Do something else
}
不應(yīng)該:
if (user.isHappy)
{
//Do something
}
else {
//Do something else
}
- 在方法之間應(yīng)該有且只有一行逞姿，這樣有利于在視覺上更清晰和更易于組織捆等。在方法內(nèi)的空白應(yīng)該分離功能续室，但通常都抽離出來成為一個新方法。
- 優(yōu)先使用auto-synthesis明郭。但如果有必要，
@synthesize和@dynamic應(yīng)該在實現(xiàn)中每個都聲明新的一行薯定。
注釋
當(dāng)需要注釋時瞳购，注釋應(yīng)該用來解釋這段特殊代碼為什么要這樣做。任何被使用的注釋都必須保持最新年堆。
盡量不要使用注釋，代碼盡可能做到自解釋变丧。只有當(dāng)斷斷續(xù)續(xù)或幾行代碼時才需要注釋缠捌。
命名
長的，描述性的方法和變量命名是好的谊却。
應(yīng)該:
UIButton *settingsButton;
或者:
UIButton *settingsBtn;
不應(yīng)該:
UIButton *setBut;
方法
在方法簽名中哑芹，應(yīng)該在方法類型(-/+ 符號)之后有一個空格。在方法各個段之間應(yīng)該也有一個空格(符合Apple的風(fēng)格)聪姿。在參數(shù)之前應(yīng)該包含一個具有描述性的關(guān)鍵字來描述參數(shù)。
"and"這個詞不應(yīng)該用來連接多個參數(shù)破喻，就像initWithWidth:height。舉個例子：
應(yīng)該:
- (void)setExampleText:(NSString *)text image:(UIImage *)image;
- (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;
- (id)viewWithTag:(NSInteger)tag;
- (instancetype)initWithWidth:(CGFloat)width height:(CGFloat)height;
不應(yīng)該:
-(void)setT:(NSString *)text i:(UIImage *)image;
- (void)sendAction:(SEL)aSelector :(id)anObject :(BOOL)flag;
- (id)taggedView:(NSInteger)tag;
- (instancetype)initWithWidth:(CGFloat)width andHeight:(CGFloat)height;
- (instancetype)initWith:(int)width and:(int)height; // Never do this.
變量
變量盡量以描述性的方式來命名曹质。單個字符的變量命名應(yīng)該盡量避免羽德，除了在for()循環(huán)。
星號表示變量是指針宅静。例如， NSString *text 既不是 NSString* text 也不是 NSString * text纤垂，除了一些特殊情況下常量。
私有屬性 應(yīng)該盡可能代替實例變量的使用洒忧。盡管使用實例變量是一種有效的方式够颠，但更偏向于使用屬性來保持代碼一致性榄鉴。
應(yīng)該:
@interface RWTTutorial : NSObject
@property (strong, nonatomic) NSString *tutorialName;
@end
不應(yīng)該:
@interface RWTTutorial : NSObject {
NSString *tutorialName;
}
NSString應(yīng)該使用copy 而不是 strong的屬性特性。
為什么庆尘？即使你聲明一個NSString的屬性，有人可能傳入一個NSMutableString的實例矛辕，然后在你沒有注意的情況下修改它付魔。
應(yīng)該:
@property (copy, nonatomic) NSString *tutorialName;
不應(yīng)該:
@property (strong, nonatomic) NSString *tutorialName;
點符號語法
點語法是一種很方便封裝訪問方法調(diào)用的方式。當(dāng)你使用點語法時几苍，通過使用getter或setter方法，屬性仍然被訪問或修改伸眶。
點語法應(yīng)該總是被用來訪問和修改屬性刽宪，因為它使代碼更加簡潔。[]符號更偏向于用在其他例子圣拄。
應(yīng)該:
NSInteger arrayCount = self.array.count;
view.backgroundColor = UIColor.orangeColor;
[UIApplication sharedApplication].delegate;
不應(yīng)該:
NSInteger arrayCount = [self.array count];
[view setBackgroundColor:[UIColor orangeColor]];
UIApplication.sharedApplication.delegate;
字面值
NSString, NSDictionary, NSArray, 和 NSNumber的字面值應(yīng)該在創(chuàng)建這些類的不可變實例時被使用。請?zhí)貏e注意nil值不能傳入NSArray和NSDictionary字面值赁遗，因為這樣會導(dǎo)致crash。
應(yīng)該:
NSArray *names = @[@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul"];
NSDictionary *productManagers = @{@"iPhone": @"Kate", @"iPad": @"Kamal", @"Mobile Web": @"Bill"};
NSNumber *shouldUseLiterals = @YES;
NSNumber *buildingStreetNumber = @10018;
不應(yīng)該:
NSArray *names = [NSArray arrayWithObjects:@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul", nil];
NSDictionary *productManagers = [NSDictionary dictionaryWithObjectsAndKeys: @"Kate", @"iPhone", @"Kamal", @"iPad", @"Bill", @"Mobile Web", nil];
NSNumber *shouldUseLiterals = [NSNumber numberWithBool:YES];
NSNumber *buildingStreetNumber = [NSNumber numberWithInteger:10018];
常量
常量是容易重復(fù)被使用和無需通過查找和代替就能快速修改值哭尝。常量應(yīng)該使用static來聲明而不是使用#define剖煌，除非顯式地使用宏。
應(yīng)該:
static NSString * const aboutViewControllerCompanyName = @"RayWenderlich.com";
static CGFloat const imageThumbnailHeight = 50.0;
不應(yīng)該:
#define CompanyName @"RayWenderlich.com"
#define thumbnailHeight 2
枚舉類型
當(dāng)使用enum時桶唐，推薦使用新的固定基本類型規(guī)格茉兰，因為它有更強(qiáng)的類型檢查和代碼補全。現(xiàn)在SDK有一個宏NS_ENUM()來幫助和鼓勵你使用固定的基本類型规脸。
例如:
typedef NS_ENUM(NSInteger, RWTLeftMenuTopItemType) {
RWTLeftMenuTopItemMain,
RWTLeftMenuTopItemShows,
RWTLeftMenuTopItemSchedule
};
你也可以顯式地賦值(展示舊的k-style常量定義)：
typedef NS_ENUM(NSInteger, RWTGlobalConstants) {
RWTPinSizeMin = 1,
RWTPinSizeMax = 5,
RWTPinCountMin = 100,
RWTPinCountMax = 500,
};
舊的k-style常量定義應(yīng)該避免除非編寫Core Foundation C的代碼。
不應(yīng)該:
enum GlobalConstants {
kMaxPinSize = 5,
kMaxPinCount = 500,
};
Case語句
大括號在case語句中并不是必須的闹丐，除非編譯器強(qiáng)制要求被因。當(dāng)一個case語句包含多行代碼時，大括號應(yīng)該加上梨与。
switch (condition) {
case 1:
// ...
break;
case 2: {
// ...
// Multi-line example using braces
break;
}
case 3:
// ...
break;
default:
// ...
break;
}
當(dāng)在switch使用枚舉類型時，'default'是不需要的航徙。例如：
RWTLeftMenuTopItemType menuType = RWTLeftMenuTopItemMain;
switch (menuType) {
case RWTLeftMenuTopItemMain:
// ...
break;
case RWTLeftMenuTopItemShows:
// ...
break;
case RWTLeftMenuTopItemSchedule:
// ...
break;
}
注意：盡量少使用switch陷虎！少使用switch！
私有屬性
私有屬性應(yīng)該在類的實現(xiàn)文件中的類擴(kuò)展(匿名分類)中聲明尚猿，命名分類(比如RWTPrivate或private)應(yīng)該從不使用除非是擴(kuò)展其他類。
例如:
@interface RWTDetailViewController ()
@property (strong, nonatomic) GADBannerView *googleAdView;
@property (strong, nonatomic) ADBannerView *iAdView;
@property (strong, nonatomic) UIWebView *adXWebView;
@end
布爾值
Objective-C使用YES和NO伴榔。因為true和false應(yīng)該只在CoreFoundation，C或C++代碼使用踪少。既然nil解析成NO，所以沒有必要在條件語句比較援奢。不要拿某樣?xùn)|西直接與YES比較，因為YES被定義為1和一個BOOL能被設(shè)置為8位集漾。
這是為了在不同文件保持一致性和在視覺上更加簡潔而考慮。
應(yīng)該:
if (someObject) {}
if (![anotherObject boolValue]) {}
不應(yīng)該:
if (someObject == nil) {}
if ([anotherObject boolValue] == NO) {}
if (isAwesome == YES) {} // Never do this.
if (isAwesome == true) {} // Never do this.
條件語句
條件語句主體為了防止出錯應(yīng)該使用大括號包圍纬霞，即使條件語句主體能夠不用大括號編寫(如驱显，只用一行代碼)。這些錯誤包括添加第二行代碼和期望它成為if語句秒紧；還有挨下，even more dangerous defect可能發(fā)生在if語句里面一行代碼被注釋了，然后下一行代碼不知不覺地成為if語句的一部分臭笆。除此之外，這種風(fēng)格與其他條件語句的風(fēng)格保持一致鹰霍，所以更加容易閱讀。
應(yīng)該:
if (!error) {
return success;
}
不應(yīng)該:
if (!error)
return success;
或
if (!error) return success;
三元操作符
當(dāng)需要提高代碼的清晰性和簡潔性時茂洒，三元操作符?:才會使用瓶竭。單個條件求值常常需要它。多個條件求值時智哀，如果使用if語句或重構(gòu)成實例變量時，代碼會更加易讀瓷叫。一般來說，最好使用三元操作符是在根據(jù)條件來賦值的情況下摹菠。
Non-boolean的變量與某東西比較，加上括號()會提高可讀性世落。如果被比較的變量是boolean類型糟需，那么就不需要括號。
應(yīng)該:
NSInteger value = 5;
result = (value != 0) ? x : y;
BOOL isHorizontal = YES;
result = isHorizontal ? x : y;
不應(yīng)該:
result = a > b ? x = c > d ? c : d : y;
Init方法
Init方法應(yīng)該遵循Apple生成代碼模板的命名規(guī)則洲押。返回類型應(yīng)該使用instancetype而不是id
- (instancetype)init {
self = [super init];
if (self) {
// ...
}
return self;
}
類構(gòu)造方法
當(dāng)類構(gòu)造方法被使用時，它應(yīng)該返回類型是instancetype而不是id体箕。這樣確保編譯器正確地推斷結(jié)果類型。
@interface Airplane
+ (instancetype)airplaneWithType:(RWTAirplaneType)type;
@end
黃金路徑
當(dāng)使用條件語句編碼時累铅，左手邊的代碼應(yīng)該是"golden" 或 "happy"路徑站叼。也就是不要嵌套if語句，多個返回語句也是OK尽楔。
應(yīng)該:
- (void)someMethod {
if (![someOther boolValue]) {
return;
}
//Do something important
}
不應(yīng)該:
- (void)someMethod {
if ([someOther boolValue]) {
//Do something important
}
}
單例模式
單例對象應(yīng)該使用線程安全模式來創(chuàng)建共享實例。
+ (instancetype)sharedInstance {
static id sharedInstance = nil;
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
sharedInstance = [[self alloc] init];
});
return sharedInstance;
}
這會防止possible and sometimes prolific crashes.
換行符
換行符是一個很重要的主題玛荞，因為它的風(fēng)格指南主要為了打印和網(wǎng)上的可讀性呕寝。
例如:
self.productsRequest = [[SKProductsRequest alloc] initWithProductIdentifiers:productIdentifiers];
一行很長的代碼應(yīng)該分成兩行代碼。
self.productsRequest = [[SKProductsRequest alloc]
initWithProductIdentifiers:productIdentifiers];
