OC代碼規(guī)范
一镜撩、代碼格式
1.1、使用空格而不是制表符Tab
不要在工程里使用 Tab 鍵讲婚，使用空格來進行縮進另锋。在 Xcode > Preferences > Text Editing 將 Tab 和自動縮進都設置為 4 個空格，因為在不同的編碼環(huán)境中狈惫，Tab鍵所設置的空格也會不一樣睛蛛，比如有的是 2 個和 4 個空格。
1.2胧谈、每一行的最大長度
同樣的忆肾，在 Xcode > Preferences > Text Editing > Page guide at column: 中將最大行長設置為 80 ，過長的一行代碼將會導致可讀性問題
1.3第岖、函數(shù)的書寫
一個典型的 Objective-C 函數(shù)應該是這樣的：
- (void)writeVideoFrameWithData:(NSData *)frameData timeStamp:(int)timeStamp {
...
}
在 - 和 (void) 之間應該有一個空格难菌，第一個大括號 { 的位置在函數(shù)所在行的末尾，同樣應該有一個空格蔑滓。
如果一個函數(shù)有特別多的參數(shù)或者名稱很長郊酒，應該將其按照:來對齊分行顯示：
-(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;
1.4函數(shù)調用
函數(shù)調用的格式和書寫差不多，可以按照函數(shù)的長短來選擇寫在一行或者分成多行：
//寫在一行
[myObject doFooWith:arg1 name:arg2 error:arg3];
//分行寫键袱，按照 : 對齊
[myObject doFooWith:arg1
name:arg2
error:arg3];
以下寫法是錯誤的：
//錯誤燎窘，要么寫在一行，要么全部分行
[myObject doFooWith:arg1 name:arg2
error:arg3];
[myObject doFooWith:arg1
name:arg2 error:arg3];
//錯誤蹄咖，按照首字母來對齊褐健。
[myObject doFooWith:arg1
name:arg2
error:arg3];
1.5、@public和@private標記符
@public和@private標記符應該以一個空格來進行縮進：
@interface MyClass : NSObject {
@public
...
@private
...
}
@end
1.6澜汤、if蚜迅，else，for應獨占一行
if (writeToFile) {
writeFileThread.interrupt(); }
if (j > 0 && j < 10) { ... // program code } else if (j >= 10 && j < 20) { ... // program code } else { ... // program code }
1.7俊抵、 不允許把多個短語句寫在一行中谁不，即一行只寫一條語句。
//錯誤
titleButton.width = 150; titleButton.height = 30;
//正確
titleButton.width = 150;
titleButton.height = 30;
二徽诲、命名規(guī)范
基本原則
2.1 清晰
命名應該盡可能的清晰和簡潔刹帕，但在Objective-C中，清晰比簡潔更重要谎替。Xcode會自動尋找類似的方法
2.2偷溺、一致性
在同一個模塊下或者派生類的時候，要遵循其基類或整體模塊的命名風格钱贯，保持命名風格一致性
2.3凡人、使用前綴
在命名某個類的時候應加上公司的前綴烙懦，在必要的時候可以加上個人的名字縮寫盖文。
2.4、命名方法
我們在方法命名時候淋肾，盡可能的把方法詳細的描述，便于自己或他人review爸邢。所以一般采用駝峰命名樊卓，而且都采用英文，千萬不要用拼音杠河。碌尔。。
- (void)getImage {
...
}
2.5券敌、命名代理
最標準的就是參照蘋果寫的代理方法
- (BOOL)tableView:(NSTableView *)tableView shouldSelectRow:(int)row;
2.6唾戚、 命名屬性
屬性的第一個字母小寫，后續(xù)單詞首字母大寫待诅。
//名詞屬性
@property (nonatomic, strong) NSString *title;
//動詞屬性
@property (nonatomic, assign) BOOL showsAlpha;
2.7叹坦、 命名變量
左右空格
int a = 5 ;
double b = 5.5 ;
2.8、 宏的命名
宏必須全部都為大寫卑雁，并且用下劃線分開
#define SCREEN_WIDTH 320.0
2.9募书、 枚舉
枚舉類型的命名規(guī)則和函數(shù)的命名規(guī)則相同
//定義一個枚舉
typedef NS_ENUM(NSInteger, NSMatrixMode) {
NSRadioModeMatrix,
NSHighlightModeMatrix,
NSListModeMatrix,
NSTrackModeMatrix
};
三、注釋
我們有寫注釋的習慣测蹲，因為很多代碼我們要經(jīng)常維護莹捡，所以有注釋維護代碼的效率會大大的提高
3.1、代碼注釋
方法扣甲、函數(shù)篮赢、類、協(xié)議琉挖、類別的定義都需要注釋启泣，蘋果很多API都有注釋，它能讓我們更好的知道該方法的用途示辈、功能种远，和如何實現(xiàn)的。
@property (nonatomic, readonly, strong, nullable)
UILabel *textLabel NS_AVAILABLE_IOS(3_0);
// default is nil.? label will be created if
necessary.
協(xié)議顽耳、委托的注釋要明確說明其被觸發(fā)的條件
/** Delegate - Sent when failed to init connection, like p2p failed. */
-(void)initConnectionDidFailed:(IPCConnectHandler *)handler;
3.2、 文件注釋
每一個文件都必須寫文件注釋妙同，文件注釋通常包含
文件所在模塊
作者信息
歷史版本信息
版權信息
文件包含的內容射富，作用
參考項目剛創(chuàng)建的時候
四、編碼風格
4.1 盡可能不要用new方法
很多人用new代替alloc init粥帚，有時候內存會有問題胰耗。蘋果大多數(shù)都用alloc init，我們盡可能跟著蘋果的風格走芒涡。
五柴灯、個人建議
5.1 Delegate要使用弱引用
代理使用weak卖漫，不要用strong，容易循環(huán)引用
5.2 @class
在.h文件中盡量少引用某個類赠群，一般我們只需要知道有這個類就可以了羊始，所以我們都會用@class，因為用#import編譯器還會去編譯那個類
5.3 盡量使用self而不是下劃線
使用self可以觸發(fā)setter和getter查描，還可以區(qū)分成員變量
5.4 屬性暴露
定義屬性時候突委，如果其他類不會用到，盡可能寫在.m文件中冬三，這樣不會暴露屬性
5.5 封裝
封裝是OC的三大特征之一匀油，我們盡可能的把一個方法或者一個類封裝，這樣可以更好的提高開發(fā)效率勾笆。
5.6 MVC
在編碼過程中敌蚜，我們必須采用MVC這種設計模式，必要的時候會采取MVVM窝爪。
5.7 設計模式的選擇
OC有20多種設計模式弛车，能用代理盡量不要用通知，能用Block最好酸舍，單例視情況而定帅韧，因為單例會獨占一塊內存
5.8 文件的存放
一般我們會采用MVC，所以控制器放在C啃勉，模型放在M忽舟，一些視圖放在V。
5.9 引用框架的根頭文件
每一個框架都會有一個和框架同名的頭文件淮阐，它包含了框架內接口的所有引用叮阅，在使用框架的時候，應該直接引用這個根頭文件泣特，而不是其它子模塊的頭文件
//正確浩姥，引用根頭文件
#import "Foundation/Foundation.h"
//錯誤，不要單獨引用框架內的其它頭文件
#import "Foundation/NSArray.h"
#import "Foundation/NSString.h"
