命名
Preferred ：
UIColor *myColor = [UIColor whiteColor];
Not Preferred ：
UIColor *myColour = [UIColor whiteColor];
代碼組織
使用#pragma mark - 將生命周期、分類方法和代理方法分塊標注管理
#pragma mark - Lifecycle
- (instancetype)init {}
- (void)dealloc {}
- (void)viewDidLoad {}
- (void)viewWillAppear:(BOOL)animated {}
- (void)didReceiveMemoryWarning {}
#pragma mark - Custom Accessors
- (void)setCustomProperty:(id)value {}
- (id)customProperty {}
#pragma mark - IBActions
- (IBAction)submitData:(id)sender {}
#pragma mark - Public
- (void)publicMethod {}
#pragma mark - Private
- (void)privateMethod {}
#pragma mark - Protocol conformance
#pragma mark - UITextFieldDelegate
#pragma mark - UITableViewDataSource
#pragma mark - UITableViewDelegate
#pragma mark - NSCopying
- (id)copyWithZone:(NSZone *)zone {}
#pragma mark - NSObject
- (NSString *)description {}
#pragma mark - lazy
空格
- 使用2個空格不要使用Tab鍵
- 方法和其他后的大括弧在第一行開始在新的一行結束黎棠。
Preferred:
if (user.isHappy) {
//Do something
} else {
//Do something else
}
Not Preferred:
if (user.isHappy)
{
//Do something
}
else {
//Do something else
}
- 在方法中的參數(shù)中間添加一個空格方便閱讀。
- 優(yōu)先使用自動生成窄驹，但是如果需要的話可以在實現(xiàn)文件中添加@ synthesize 和 @dynamic。
- 調用方法時盡量避免方法中冒號對齊证逻。當方法中包含3個以上的參數(shù)乐埠，使用冒號對齊會增加方法的可讀性。但是囚企，當方法中包含block時Xcode 的自動對齊會讓代碼看起來不容易分辨丈咐。
Preferred：
// blocks are easily readable
[UIView animateWithDuration:1.0 animations:^{
// something
} completion:^(BOOL finished) {
// something
}];
Not Preferred:
// colon-aligning makes the block indentation hard to read
[UIView animateWithDuration:1.0
animations:^{
// something
}
completion:^(BOOL finished) {
// something
}];
注釋
所有的注釋必須保持最新或者刪除，避免塊注釋龙宏。
命名
盡量保持蘋果的命名方式棵逊，長的，描述性和變量名都很好银酗。
Preferred:
UIButton *settingsButton;
Not Preferred:
UIButton *setBut;
對于類名和常量名一般使用三字母前綴辆影，在coreData 實體名稱可以省略。常量一般遵循駝峰命名方式黍特，使用相關類名最為前綴蛙讥。
Preferred：
static NSTimeInterval const RWTTutorialViewControllerNavigationFadeAnimationDuration = 0.3;
Not Preferred:
static NSTimeInterval const fadetime = 1.7;
屬性命名應該遵循首字母小寫的駝峰原則。盡量使用自動生成而非手動灭衷。
Preferred：
@property (strong, nonatomic) NSString *descriptiveVariableName;
Not Preferred:
id varnm;
下劃線
在初始化的時候次慢，實例變量使用下劃線。局部變量不要使用下劃線今布。
方法
在(+/-)符號后添加一個空格，關鍵詞應該對參數(shù)有簡單的描述拭抬。
關鍵字and的使用不建議使用在多參數(shù)的方法名中部默。
Preferred:
- (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;
Not Preferred:
-(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.
變量
應該使用可描述的變量名稱。單字符變量名除了在for循環(huán)中使用其他情況不宜使用造虎。
*號應該跟在變量前傅蹂，NSString text not NSString text;
盡量使用私有屬性代替實例變量。
Preferred：
@interface RWTTutorial : NSObject
@property (strong, nonatomic) NSString *tutorialName;
@end
Not Preferred：
@interface RWTTutorial : NSObject {
NSString *tutorialName;
}
屬性
Preferred：
@property (weak, nonatomic) IBOutlet UIView *containerView;
@property (strong, nonatomic) NSString *tutorialName;
Not Preferred：
@property (nonatomic, weak) IBOutlet UIView *containerView;
@property (nonatomic) NSString *tutorialName;
字符串屬性推薦使用copy不建議使用strong算凿。
Preferred:
@property (copy, nonatomic) NSString *tutorialName;
Not Preferred:
@property (strong, nonatomic) NSString *tutorialName;
點語法
Preferred:
NSInteger arrayCount = [self.array count];
view.backgroundColor = [UIColor orangeColor];
[UIApplication sharedApplication].delegate;
Not Preferred:
NSInteger arrayCount = self.array.count;
[view setBackgroundColor:[UIColor orangeColor]];
UIApplication.sharedApplication.delegate;
字面量
NSString, NSDictionary, NSArray, and NSNumber中盡量使用不可變的值份蝴。不要在NSArray 和NSDictionary中添加nil值會引起崩潰。
Preferred ：
NSArray *names = @[@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul"];
NSDictionary *productManagers = @{@"iPhone": @"Kate", @"iPad": @"Kamal", @"Mobile Web": @"Bill"};
NSNumber *shouldUseLiterals = @YES;
NSNumber *buildingStreetNumber = @10018;
Not Preferred:
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];
常量
常量應該是靜態(tài)的常量氓轰，不應該是#define 除非作為宏使用婚夫。
Perferred：
static NSString * const RWTAboutViewControllerCompanyName = @"RayWenderlich.com";
static CGFloat const RWTImageThumbnailHeight = 50.0;
Not Perferred：
#define CompanyName @"RayWenderlich.com"#define thumbnailHeight 2
枚舉類型
For Example：
typedef NS_ENUM(NSInteger, RWTLeftMenuTopItemType) {
RWTLeftMenuTopItemMain,
RWTLeftMenuTopItemShows,
RWTLeftMenuTopItemSchedule
};
你可以明確值的分配
typedef NS_ENUM(NSInteger, RWTGlobalConstants) {
RWTPinSizeMin = 1,
RWTPinSizeMax = 5,
RWTPinCountMin = 100,
RWTPinCountMax = 500,
};
Not Preferred:
enum GlobalConstants {
kMaxPinSize = 5,
kMaxPinCount = 500,
};
case 狀態(tài)
當在switch中使用枚舉類型，default是不需要的署鸡。
RWTLeftMenuTopItemType menuType = RWTLeftMenuTopItemMain;
switch (menuType) {
case RWTLeftMenuTopItemMain:
// ...
break;
case RWTLeftMenuTopItemShows:
// ...
break;
case RWTLeftMenuTopItemSchedule:
// ...
break;
}
私有屬性
私有屬性應該在類的實現(xiàn)文件中的類擴展(匿名分類)中聲明案糙，命名分類(比如RWTPrivate或private)應該從不使用除非是擴展其他類限嫌。匿名分類應該通過使用<headerfile>+Private.h文件的命名規(guī)則暴露給測試。
@interface RWTDetailViewController ()
@property (strong, nonatomic) GADBannerView *googleAdView;
@property (strong, nonatomic) ADBannerView *iAdView;
@property (strong, nonatomic) UIWebView *adXWebView;
@end
布爾類型
Preferred：
if (someObject) {}
if (![anotherObject boolValue]) {}
Not Preferred：
if (someObject == nil) {}
if ([anotherObject boolValue] == NO) {}
if (isAwesome == YES) {} // Never do this.
if (isAwesome == true) {} // Never do this.
如果BOOL屬性的名字是一個形容詞时捌，屬性就能忽略"is"前綴怒医，但要指定get訪問器的慣用名稱。
@property (assign, getter=isEditable) BOOL editable;
條件語句
- 后面要加大括號
Preferred：
if (!error) {
return success;
}
Not Preferred：
if (!error)
return success;
or
if (!error) return success;
三目運算符
Preferred：
NSInteger value = 5;
result = (value != 0) ? x : y;
BOOL isHorizontal = YES;
result = isHorizontal ? x : y;
Not Preferred：
result = a > b ? x = c > d ? c : d : y;
初始化方法
- 返回類型是instancetype不是返回id奢讨。確保編譯器正確判斷推斷結果稚叹。
- (instancetype)init {
self = [super init];
if (self) {
// ...
}
return self;
}
類構造方法
要求同上
@interface Airplane
+ (instancetype)airplaneWithType:(RWTAirplaneType)type;
@end
CGRect 方法
- 訪問x,y,width或者height時使用CGGeometry來訪問。
Preferred：
CGRect frame = self.view.frame;
CGFloat x = CGRectGetMinX(frame);
CGFloat y = CGRectGetMinY(frame);
CGFloat width = CGRectGetWidth(frame);
CGFloat height = CGRectGetHeight(frame);
CGRect frame = CGRectMake(0.0, 0.0, width, height);
Not Preferred：
CGRect frame = self.view.frame;
CGFloat x = frame.origin.x;
CGFloat y = frame.origin.y;
CGFloat width = frame.size.width;
CGFloat height = frame.size.height;
CGRect frame = (CGRect){ .origin = CGPointZero, .size = frame.size };
Golden Path
Preferred:
- (void)someMethod {
if (![someOther boolValue]) {
return;
}
//Do something important
}
Not Preferred:
- (void)someMethod {
if ([someOther boolValue]) {
//Do something important
}
}
錯誤處理
判斷返回值而不是錯誤變量拿诸。
Preferred:
NSError *error;
if (![self trySomethingWithError:&error]) {
// Handle Error
}
Not Preferred:
NSError *error;
[self trySomethingWithError:&error];
if (error) {
// Handle Error
}
單例模式
- 使用線程安全方式創(chuàng)建實例扒袖。
+ (instancetype)sharedInstance {
static id sharedInstance = nil;
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
sharedInstance = [[self alloc] init];
});
return sharedInstance;
}
換行符
一行代碼太長的話可以使用換行符，換成兩行佳镜。
self.productsRequest = [[SKProductsRequest alloc] initWithProductIdentifiers:productIdentifiers];
down
self.productsRequest = [[SKProductsRequest alloc]
initWithProductIdentifiers:productIdentifiers];
- 少用++ -- 運算符
- 規(guī)范只是建議不要拘泥
- 對于文章的大部分內容還是認同的僚稿，但是對于方法名(+/-)符號后添加空格，就個人而言感覺意義并不大蟀伸。
