Objective-C-Normal-styling

• Refer to https://github.com/NYTimes/objective-c-style-guide
• Refer to https://github.com/github/objective-c-style-guide
• Refer to https://gist.github.com/soffes/812796

Operators

運算子與變數名稱之間應加空白，除了 ++ 及 -- 之外

NSString *foo = @"bar";
NSInteger answer = 42;
answer += 9;
answer++;
answer = 40 + 2;

屬性與方法

屬性使用.來呼叫，方法則使用中括號 [ ]

For example

view.backgroundColor = UIColor.orangeColor;
UIApplication.sharedApplication.delegate;

Not

[view setBackgroundColor:[UIColor orangeColor]];
[UIApplication sharedApplication].delegate;

方法

• 方法的宣告中，- 與 + 前後需接一個空格，參數之間也接一個空格。
• 私有方法使用 _ 為前綴字。

For example

// Public method
- (void)setExampleText:(NSString *)text image:(UIImage *)image;

// Private method
- (void)_setupView;

初始化

• init 初始化應回傳 instancetype

For example

- (instancetype)init {
    self = [super init]; // or call the designated initializer
    if (self) {
        // Custom initialization
    }
    return self;
}

關於換行

• @synthesize 及 @dynamic 每個都應該一個宣告一行。
• 方法與方法之間，需空一行，以便整理及視覺乾淨。

方法換行

方法之大括號 { }，起始於同一行，結束於下一行。

For example

- (void)_setupView {
    // Do something
}

方法內換行

• if/else/switch/while 大括號 { }，起始於同一行，結束於下一行。
• if 中 else / else if 應於 } 同一行

For example

if (user.isHappy) {
    // Do something
} else {
    // Do something else
}

條件判斷

條件式的判斷必須用大括號來區分，不使用單行。

For example

if (!error) {
    return success;
}

Not

if (!error)
    return success;
    
if (!error) return success;

變數

變數命名使用首字小寫，駝峰式命名，可立即看出變數意義為主，型態接於字串後方，且避免使用單一字母命名，除了 for 內之loop變數。

For example

• NSString *title: 可假設 title 為 NSString 型態。
• NSString *titleHTML: 可假設 titleHTML 為 NSString 型態。
• NSAttributedString *titleAttributedString
• NSDate *now: 可假設 now 為 NSDate 型態。
• NSDate *lastModifiedDate: 應明確定義出上次修改時間為 NSDate 型態。
• NSURL *url vs. NSString *urlString
• NSString *releaseDateString: 命名為 String 可避免型態誤會的情形。
• UIButton *settingButton: button / label / image / image view 元件名稱應完整定義出

變數之指標與變數相關，因此應緊跟於變數

For example

NSString *text

Not

NSString* text 
NSString * text

變數修飾詞

__strong, __weak, __unsafe_unretained, __autoreleasing 接於變數型態前面

For example

__weak NSString *text

properties 修飾詞

nonatomic 需先放，接著是 strong weak assign

@property (nonatomic, assign) UIColor *topColor;
@property (nonatomic, weak) id delegate;
@property (nonatomic, strong) UIActivityIndicatorView *activityIndicator;

Categories

Categories 命名以功能性為方向

For example

@interface UIViewController (NYTMediaPlaying)
@interface NSString (NSStringEncodingDetection)

Not

@interface NYTAdvertisement (private)
@interface NSString (NYTAdditions)

若增加方法或屬性於 Category，其命名應使用 app/organization 做為前綴字，以避免與其他第三方 Category 相衝

For example

@interface NSArray (NYTAccessors)
- (id)nyt_objectOrNilAtIndex:(NSUInteger)index;
@end

Not

@interface NSArray (NYTAccessors)
- (id)objectOrNilAtIndex:(NSUInteger)index;
@end

Enumerated Types

使用 NS_ENUM() 及 NSInteger 定義，項目命名應以該 type 為前綴字

For example

typedef NS_ENUM(NSInteger, NYTAdRequestState) {
    NYTAdRequestStateInactive,
    NYTAdRequestStateLoading
};

Bitmasks

使用 NS_ENUM() 及 NSUInteger 定義，項目命名應以該 type 為前綴字

For example

typedef NS_OPTIONS(NSUInteger, NYTAdCategory) {
    NYTAdCategoryAutos      = 1 << 0,
    NYTAdCategoryJobs       = 1 << 1,
    NYTAdCategoryRealState  = 1 << 2,
    NYTAdCategoryTechnology = 1 << 3
};

NSArray, NSDictionary

使用@[]及@{}來定義，Mutable 則使用 mutable copy 方法

NSArray *array = @[@"1", @"2"];
NSDictionary *dict = @{@"key" : @"2"};

NSMutableArray *mutableArray = [@[@"1", @"2"] mutableCopy];

Block

名稱與 return type 之間需空白

void (^blockName1)(void) = ^{
    // do some things
};

id (^blockName2)(id) = ^ id (id args) {
    // do some things
};