iOS中書寫代碼規(guī)范34條小建議

1.精簡代碼, 返回最后一句的值椿息,這個方法有一個優(yōu)點鸿捧,所有的變量都在代碼塊中泻轰,也就是只在代碼塊的區(qū)域中有效铺然,這意味著可以減少對其他作用域的命名污染俗孝。但缺點是可讀性比較差
NSURL *url = ({ NSString *urlString = [NSString 
stringWithFormat:@"%@/%@", baseURLString, endpoint];
[NSURL URLWithString:urlString];});
2.關于編譯器:關閉警告
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
[myObj performSelector:mySelector withObject:name];
#pragma clang diagnostic pop
3.忽略沒用的變量
#pragma unused (foo)明確定義錯誤和警告
#error Whoa, buddy, you need to check for zero here!
#warning Dude, don't compare floating point numbers like this!
4.避免循環(huán)引用
  • 如果【block內部】使用【外部聲明的強引用】訪問【對象A】, 那么【block內部】會自動產(chǎn)生一個【強引用】指向【對象A】
  • 如果【block內部】使用【外部聲明的弱引用】訪問【對象A】, 那么【block內部】會自動產(chǎn)生一個【弱引用】指向【對象A】
__weak typeof(self) weakSelf = self;
dispatch_block_t block = ^{ [weakSelf doSomething];// weakSelf != nil
// preemption, weakSelf turned nil
[weakSelf doSomethingElse];// weakSelf == nil};
//最好這樣調用:
__weak typeof(self) weakSelf = self;
myObj.myBlock = ^{
__strong typeof(self) strongSelf = weakSelf;
if (strongSelf) { 
       [strongSelf doSomething];// strongSelf != nil
// preemption, strongSelf still not nil(搶占的時候,strongSelf 還是非 nil 的)
[strongSelf doSomethingElse];// strongSelf != nil }
else {
 // Probably nothing... return;
       }
};
5.宏要寫成大寫,至少要有大寫,全部小寫有時候書寫不提示參數(shù)
6.建議書寫枚舉模仿蘋果——在列出枚舉內容的同時綁定了枚舉數(shù)據(jù)類型NSUInteger魄健,這樣帶來的好處是增強的類型檢查和更好的代碼可讀性,示例:
// 推薦寫法
typedef NS_OPTIONS(NSUInteger, UIControlState) { 
UIControlStateNormal = 0, 
UIControlStateHighlighted = 1 << 0, 
UIControlStateDisabled = 1 << 1
};
// 不推薦寫法
typedef enum{ 
UIControlStateNormal = 0,
 UIControlStateHighlighted = 1 << 0, 
UIControlStateDisabled = 1 << 1
} 
UIControlState;
7.建議加載xib,xib名稱用NSStringFromClass(),避免書寫錯誤
// 推薦寫法
[self.tableView registerNib:
[UINib nibWithNibName:NSStringFromClass([DXRecommendTagVCell class]) bundle:nil] 
forCellReuseIdentifier:ID];
// 不推薦寫法
 [self.tableView registerNib:
[UINib nibWithNibName:
@"DXRecommendTagVCell" bundle:nil] forCellReuseIdentifier:ID];
8.場景需求:在繼承中,凡是要求子類重寫父類的方法必須先調用父類的這個方法進行初始化操作;建議:父類的方法名后面加上NS_REQUIRES_SUPER; 子類重寫這個方法就會自動警告提示要調用這個super方法,示例代碼
// 注意:父類中的方法加`NS_REQUIRES_SUPER`,子類重寫才有警告提示
- (void)prepare NS_REQUIRES_SUPER;
9.建議書寫屬性名不要和系統(tǒng)一樣,避免發(fā)生莫名其妙的問題;特別注意的是label;屬性名不要寫成textLabel
10.項目中添加plist類型文件,不要命名為info.plist,以防止和系統(tǒng)自帶的文件重名,發(fā)生莫名其妙的問題;
11.如果控制器已經(jīng)加載過,就不用再次加載,優(yōu)化性能
    if (vc.isViewLoaded) return;
12.id類型屬性不能用點語法,調用get方法只能用中括號調用,[id 方法名],利用iOS9新特性泛型就可以; 比如數(shù)組;
@property (nonatomic,strong) NSMutableArray<DXTopics *> *topicsM;
13.如果不是屬性,盡量不要點語法,一個老程序員的建議;
14.使用第三方框架,盡量不要更改內部文件,而應該再次封裝,個性定制;
15.判斷if書寫方式
  • 建議這樣寫
- (CGFloat)tableView:(UITableView *)tableView heightForRowAtIndexPath:
(NSIndexPath *)indexPath
{
    if (indexPath.row == 0) return 44;
    if (indexPath.row == 1) return 80;
    if (indexPath.row == 2) return 50;
    return 44;
}
  • 而不是
- (CGFloat)tableView:(UITableView *)tableView heightForRowAtIndexPath:
(NSIndexPath *)indexPath
{
    if (indexPath.row == 0) {
        return 44;
    }else if (indexPath.row == 1){
        return 80;
    }else if (indexPath.row == 2){
        return 50;
    }else{
        return 44;
    }
}

16.接手一個新項目,快速的調試,查看某個模塊或者方法的作用,需要注釋掉一個方法,或者某個代碼塊,直接寫return;而不是全選,注釋掉;

比如:查看這個方法loadNewRecommendTags作用

- (void)loadNewRecommendTags
{
    return;

    [SVProgressHUD show];
    // 取消之前的任務
    [self.manager.tasks makeObjectsPerformSelector:@selector(cancel)];
    NSMutableDictionary *params = [NSMutableDictionary dictionary];

    params[@"a"] = @"tag_recommend";
    params[@"c"] = @"topic";
    params[@"action"] = @"sub";
    [self.manager GET:DXCommonUrlPath parameters:params success:
^(NSURLSessionDataTask * _Nonnull task, id  _Nonnull responseObject) {
self.recommendTag = [DXRecommendTag mj_objectArrayWithKeyValuesArray:
responseObject];
        [self.tableView reloadData];
        [SVProgressHUD dismiss];
    } failure:
^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
        DXLog(@"%@",error);
        [SVProgressHUD dismiss];
    }];
}
17.在一個自定義的View中,或者自定義cell中,modal出一個控制器建議:
[UIApplication sharedApplication].keyWindow.rootViewController;
  • 代替
self.window.rootViewController
  • 因為程序可能不止一個window,self.window可能不是主窗口;
18.建議:用CGSizeZero 代替 CGSizeMake(0,0);

CGRectZero代替CGRectMake(0, 0, 0, 0);
CGPointZero代替CGPointMake(0, 0)

19.監(jiān)聽鍵盤的通知建議:
UIKIT_EXTERN NSString *const UIKeyboardWillChangeFrameNotification

而不是,下面代碼;因為鍵盤可能因為改變輸入法,切換成表情輸入,切換成英文,那么frame可能會變高,變矮,不一定會發(fā)出下面這些通知,但是肯定會發(fā)上面的通知

UIKIT_EXTERN NSString *const UIKeyboardWillShowNotification;
UIKIT_EXTERN NSString *const UIKeyboardDidShowNotification;
UIKIT_EXTERN NSString *const UIKeyboardWillHideNotification;
UIKIT_EXTERN NSString *const UIKeyboardDidHideNotification;
20.發(fā)布通知的字符串常量規(guī)范,建議模仿蘋果;如上鍵盤的通知的書寫,加上const 保證字符串不可更改,以Notification結尾,一看就知道是通知;應盡量保證可讀性,不要怕句子太長;
NSString *const buttonDidClickNotification = @"buttonDidClickNotification";
21.如果除數(shù)為0,iOS8以下會直接報錯,(NaN—>Not a Number)iOS9不會,所以應該判斷,比如服務器返回圖片的寬高,按比例縮放
CGFloat contentH = textW * self.height / self.width;
22.如果聲明的屬性,只想使用的get方法,不使用set方法,并且不想讓外界更改這個屬性的值,那么建議在括號里面加readonly;示例:
@property(nonatomic,readonly,getter=isKeyWindow) BOOL keyWindow;
23.如果屬性是BOOL類型,建議在括號中重寫get方法名稱,以提高可讀性
@property(nonatomic,readonly,getter=isKeyWindow) BOOL keyWindow;
24.從系統(tǒng)相冊中取照片之前,應該判斷系統(tǒng)相冊是否可用,如果從相機中拍照獲取,要判斷相機是否可用
// 判斷相冊是否可以打開
if (![UIImagePickerController isSourceTypeAvailable:
UIImagePickerControllerSourceTypePhotoLibrary]) return;
//  判斷相機是否可以打開
if (![UIImagePickerController isSourceTypeAvailable:
UIImagePickerControllerSourceTypeCamera]) return;
25.在導航控制中,或它的子控制器,設置導航欄的標題應該用self.navigationItem.title = @“標題”而不建議self.title = @“標題”;
26.給cell設置分割線,建議用setFrame:通過設置它高度,設置分割線,而不推薦用給cell底部添加一個高度的UIView,這樣做增加了一個控件,從性能上來講,不如用setFrame設置高度
27.大量操作圖層會可能造成應用很卡,給用戶體驗差,所以盡量不要操作圖層;比如設置按鈕圓角,比如給button設置圓角;
self.loginBtn.layer.cornerRadius = 5;
self.loginBtn.layer.masksToBounds = YES;
28.給分類擴充方法,建議加上前綴,比如第三方框架SDWebImage,這樣做跟系統(tǒng)的方法很容易區(qū)分開,減少了程序員之間的溝通成本,同理跟分類添加屬性(利用運行時),建議加前綴,以防止蘋果官方過一段時間添加了一模一樣的屬性名,比如給UITextField分類添加了placeholderColor這個屬性,萬一某天官方給placeholder擴充了這個命名一模一樣的屬性,那么就不好了
29.凡是在storyboard或者xib中給某個控件添加顏色,顏色對角線有分割線,表示可以設置透明度,如果給這個控件設置透明度建議在這里設置,而不是設置alpha,因為設置了alpha,那么上面有文字也會隨著透明度變大,而變得不清楚;可以設置background -->other -->opacity
30.整形轉化成浮點型,不建議這么寫 a / b 1.0,這樣寫是錯誤寫法,示例1.5 / 2 1.0;根據(jù)運算法則,從作到右,0 1.0 == 0,而應該在前面寫1.0 1.5 /2;建議直接強轉;(double)a/b;
31.抽取方法,或者寫工具類,能寫類方法,盡量寫成類方法,減少了創(chuàng)建對象的步驟,比如給UIView擴充分類加載xib,viewWithXib;
32.耗時操作應該放在子線程,避免卡主主線程,比如計算文件大小,下載大文件,清除緩存;
33.聲明一個屬性,如果是對象,比如數(shù)組,不能以new單詞開始,否則直接報錯,因為new在OC中是生成一個對象的方法,有特殊含義;比如,
@property (nonatomic,strong) NSMutableArray<DXTopics *> *newTopicsM;
  • 注意:如果newtopicsM是一個單詞(區(qū)別于駝峰標志),這樣寫不會報錯;如果是基本數(shù)據(jù)類型則不會報錯,比如
@property (nonatomic,assign) int newNumber;
  • 但是如果一定要寫new單詞開頭的屬性,那么聲明屬性的時候,重寫getter方法名稱只不過使用getter方法的時候注意下
34.在自定義方法中,and這個詞的用法應該保留赋铝。它不應該用于多個參數(shù)來說明,就像initWithWidth:height以下這個例子:
- (instancetype)initWithWidth:(CGFloat)width height:(CGFloat)height;
//而不應該
- (instancetype)initWithWidth:(CGFloat)width andHeight:(CGFloat)height;

如果有錯,歡迎指正,互相學習,我的QQ664995775

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末沽瘦,一起剝皮案震驚了整個濱河市革骨,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌析恋,老刑警劉巖苛蒲,帶你破解...
    沈念sama閱讀 216,591評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異绿满,居然都是意外死亡,警方通過查閱死者的電腦和手機窟扑,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,448評論 3 392
  • 文/潘曉璐 我一進店門喇颁,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人嚎货,你說我怎么就攤上這事橘霎。” “怎么了殖属?”我有些...
    開封第一講書人閱讀 162,823評論 0 353
  • 文/不壞的土叔 我叫張陵姐叁,是天一觀的道長塑崖。 經(jīng)常有香客問我遣铝,道長,這世上最難降的妖魔是什么贞间? 我笑而不...
    開封第一講書人閱讀 58,204評論 1 292
  • 正文 為了忘掉前任挠唆,我火速辦了婚禮处窥,結果婚禮上,老公的妹妹穿的比我還像新娘玄组。我一直安慰自己滔驾,他們只是感情好谒麦,可當我...
    茶點故事閱讀 67,228評論 6 388
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著哆致,像睡著了一般绕德。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上摊阀,一...
    開封第一講書人閱讀 51,190評論 1 299
  • 那天耻蛇,我揣著相機與錄音,去河邊找鬼驹溃。 笑死城丧,一個胖子當著我的面吹牛,可吹牛的內容都是我干的豌鹤。 我是一名探鬼主播亡哄,決...
    沈念sama閱讀 40,078評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼布疙!你這毒婦竟也來了蚊惯?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 38,923評論 0 274
  • 序言:老撾萬榮一對情侶失蹤灵临,失蹤者是張志新(化名)和其女友劉穎截型,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體儒溉,經(jīng)...
    沈念sama閱讀 45,334評論 1 310
  • 正文 獨居荒郊野嶺守林人離奇死亡宦焦,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,550評論 2 333
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了顿涣。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片波闹。...
    茶點故事閱讀 39,727評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖涛碑,靈堂內的尸體忽然破棺而出精堕,到底是詐尸還是另有隱情,我是刑警寧澤蒲障,帶...
    沈念sama閱讀 35,428評論 5 343
  • 正文 年R本政府宣布歹篓,位于F島的核電站,受9級特大地震影響揉阎,放射性物質發(fā)生泄漏庄撮。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,022評論 3 326
  • 文/蒙蒙 一毙籽、第九天 我趴在偏房一處隱蔽的房頂上張望重窟。 院中可真熱鬧,春花似錦惧财、人聲如沸巡扇。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,672評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽厅翔。三九已至乖坠,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間刀闷,已是汗流浹背熊泵。 一陣腳步聲響...
    開封第一講書人閱讀 32,826評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留甸昏,地道東北人顽分。 一個月前我還...
    沈念sama閱讀 47,734評論 2 368
  • 正文 我出身青樓,卻偏偏與公主長得像施蜜,于是被迫代替她去往敵國和親卒蘸。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 44,619評論 2 354

推薦閱讀更多精彩內容

  • 轉自:船長_iOS開發(fā)公眾號 1.精簡代碼, 返回最后一句的值翻默,這個方法有一個優(yōu)點缸沃,所有的變量都在代碼塊中,也就是...
    smm987閱讀 289評論 0 0
  • 1.精簡代碼, 返回最后一句的值修械,這個方法有一個優(yōu)點趾牧,所有的變量都在代碼塊中,也就是只在代碼塊的區(qū)域中有效肯污,這意味...
    船長_閱讀 11,318評論 22 107
  • Spring Cloud為開發(fā)人員提供了快速構建分布式系統(tǒng)中一些常見模式的工具(例如配置管理翘单,服務發(fā)現(xiàn),斷路器蹦渣,智...
    卡卡羅2017閱讀 134,652評論 18 139
  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,077評論 25 707
  • “我知道這個世界每天都有太多遺憾” 鮑伯·迪倫獲諾貝爾文學獎属提,宋冬野吸毒被抓权逗。 關你P事。 前段時間一直很紅火的吸...
    南瓜口袋閱讀 185評論 0 0