iOS代碼規(guī)范
命名規(guī)范
1.0 對于常量的命名最好在前面加上字母k作為標(biāo)記. 如:
static const NSTimeInterval kAnimationDuration = 0.3;
定義作為NSDictionary或者Notification等的Key值字符串時(shí)加上const關(guān)
鍵字, 以防止被修改. 如:
NSString *const UIApplicationDidEnterBackgroundNotification
Tips:
<pre><code>
I. 若常量作用域超出編譯單元(實(shí)現(xiàn)文件), 需要在類外可見時(shí), 使用
extern關(guān)鍵字, 并加上該類名作為前綴. 如 extern NSString *const
PGThumbnailSize
II.全局常量(通知或者關(guān)鍵字等)盡量用const來定義. 因?yàn)槿绻褂煤甓?br>
義, 一來宏可能被重定義. 二來引用不同的文件可能會(huì)導(dǎo)致宏的不同. P.S.
對于＃define也添加一下前綴k(其實(shí)有點(diǎn)強(qiáng)迫癥, 哈哈...)
</code></pre>
2.0 對于變量的命名規(guī)范
Tip:iOS命名兩大原則是:可讀性高和防止命名沖突(通過加前綴來保證). Objective-C 的命名通常都比較長, 名稱遵循駝峰式命名法.
實(shí)例
<pre><code>
//字符串聲明后綴以Str結(jié)尾
NSString *phoneStr;
//錯(cuò)誤示例
NSString *str1;//不應(yīng)以數(shù)字作為變量后綴，變量聲明應(yīng)具有一定的可識(shí)別程度
</pre></code>變量后綴
<pre><code>
<>NSString; ----- Str,
NSMutableString ---- StrM;
NSArray; ----- Arr,
NSMutableArray ----- ArrM;
NSDictionary ---- Dic,
NSMutableDictionary ----DicM,
UILabel ----lab,
UIButton ----btn,
UITableView ---- tab,
UICollectionView ---- CollView,
UITextFiled ----TF,
UITextView ---- TV,
UIView ---- View,</pre></code>
- 枚舉變量的聲明規(guī)范
建議使用基于Objective -c的枚舉羽莺，更易讀赞弥，枚舉里面的類型盡量使用全部的大寫屏镊，區(qū)分的話可用下劃線后單詞進(jìn)行區(qū)別
<pre><code>
typedef NS_ENUM(NSInteger, UIViewAnimationTransition) {
UIViewAnimationTransitionNone,
UIViewAnimationTransitionFlipFromLeft,
UIViewAnimationTransitionFlipFromRight,
UIViewAnimationTransitionCurlUp,
UIViewAnimationTransitionCurlDown,
};
</pre></code>
不建議使用基于C的枚舉
<pre><code>
typedef enum : {
CameraModeFront,
CameraModeLeft,
CameraModeRight,
} CameraMode
</pre></code>
條件判斷
<li> 單層的判斷語句不建議使用if else 邏輯語句</li>
不建議 <pre><code>
if (條件)else {
.....
}</pre></code>
建議使用三目運(yùn)算符
<pre><code>result = object ? : [self createObject]; </pre></code>
<li>嵌套判斷 </li>
<pre><code>
if (!user.UserName) return NO;
if (!user.Password) return NO;
if (!user.Email) return NO;
return YES;</pre></code>
不應(yīng)該：實(shí)例
<pre><code>
BOOL isValid = NO;
if (user.UserName)
{
if (user.Password)
{
if (user.Email) isValid = YES;
}
}
return isValid;</pre></code>
判斷條件的編寫
<li> 判斷條件在后 </li>
<pre><code>if(self.name = nil) </pre></code>
<li>錯(cuò)誤寫法</li>
<pre><code>if(nil = self.name)</pre></code>
初始化方法
<li> 初始化變量時(shí)候盡量使用字面量語法進(jìn)行初始化</li>
<pre><code>
NSArray *names = @[@"Brian", @"Matt", @"Chris", @"Alex", @"Steve"];
NSDictionary *productManagers = @{@"iPhone" : @"Kate", @"iPad" : @"Kamal"};
NSNumber *shouldUseLiterals = @YES;
NSNumber *buildingZIPCode = @10018;</pre></code>
第一個(gè)好處是簡潔, 第二個(gè)好處是可以防止初始化進(jìn)去nil值造成crash
方法的寫法
<li>方法里面參數(shù)過多的時(shí)候</li>
<pre><code>
- (void)registerUserName:(NSString *)userName
password:(NSString *)password
email:(NSString *)email
{
// to do...
}
</pre></code>
Block的循環(huán)使用問題
<li>block內(nèi)部使用弱引用</li>
<pre><code>
__weak typeof(self) weakSelf = self;
dispatch_block_t block = ^{
[weakSelf doSomething]; // weakSelf != nil
// preemption, weakSelf turned nil
[weakSelf doSomethingElse]; // weakSelf == nil
};
</pre></code>
以上那樣寫并不完美只厘，block體里面的self是weak的, 所以就有可能在某一個(gè)時(shí)段self已經(jīng)被釋放了, 這時(shí)block體里面再使用self那就是nil
解決方法很簡單, 就是在block體內(nèi)define一個(gè)strong的self, 然后執(zhí)行的時(shí)候判斷下self是否還在, 如果在就繼續(xù)執(zhí)行下面的操作, 否則return或拋出異常
<pre><code>
__weak typeof(self) weakSelf = self;
myObj.myBlock = ^{
__strong typeof(self) strongSelf = weakSelf;
if (strongSelf) {
[strongSelf doSomething]; // strongSelf != nil
// preemption, strongSelf still not nil
[strongSelf doSomethingElse]; // strongSelf != nil
}
else {
// Probably nothing...
return;
}
};
</pre></code>
避免龐大的xib
可分為多個(gè)模塊進(jìn)行涌献，xib在進(jìn)行編譯的時(shí)候會(huì)把所有的資源文件加載一次
賦值語句
賦值語句等號(hào)左右各加一個(gè)空格
錯(cuò)誤示例
<pre><code>NSString *str=@"1";
</pre></code>
正確示例
<pre><code>NSString *str = @"1";</pre></code>
