ios開發(fā)代碼規(guī)范

原文鏈接:http://www.cocoachina.com/ios/20160324/15727.html

今天看了一篇關(guān)于代碼規(guī)范的文章,感覺自己寫代碼還是比較注重規(guī)范的,不談維護性,至少看上去代碼很整潔,很規(guī)范簸呈。于是乎,寫一篇文章來記錄下讓更多的開發(fā)可以學(xué)習(xí)下;規(guī)范其實是沒有一個標準的蒿涎,有些東西你遵守了他就是規(guī)范,不遵守就不是規(guī)范惦辛,但是你遵守了卻能讓代碼規(guī)范起來劳秋。

摘錄了一些比較常見的規(guī)范,括號里寫了自己的一些看法胖齐。

1玻淑、 在每個方法的定義前留白一行,也就是在方法和方法之間留空一行呀伙。(很多人不空行补履,導(dǎo)致代碼看起來一大坨,很不舒服剿另,閱讀性很差)

2箫锤、 功能相近的方法要放在一起贬蛙,并推薦使用#pragma mark - ***來導(dǎo)航代碼,切分代碼塊谚攒。這樣可以方便函數(shù)的查找阳准。并且可以使用快捷鍵control+6 來快速查找方法的位置。(這個還是很有必要的馏臭,分門別類溺职,找起來很方便,不至于跨度很大)

3位喂、 二元運算符和參數(shù)之間要有一個空格浪耘,如賦值號=左右各留一個空格。(這個雖然很小的點塑崖,但是卻能讓代碼更美觀七冲,不至于代碼很擁擠)

self.myString = @"235423rew523452345";

4、 盡量減少在代碼中直接使用數(shù)字常量规婆,而使用宏定義等方式澜躺。如:MAX_NUMBER_PHONE替代8等等。這樣我們搜索也比較方便抒蚜。(建議直接在工程中開一個單獨的文件去存儲哪些需要定義很多公用常量的情況掘鄙,在大型企業(yè)級項目中顯得尤為重要)

5、 宏定義全部字母大寫嗡髓。(很多新手容易會和常量的定義混淆操漠,甚至以k開頭大小寫混合)

6、對傳入?yún)?shù)的保護或者說是否為空的判斷饿这,盡量不要使用if(!obj),而使用NSAssert斷言來處理浊伙。NSAssert是系統(tǒng)定義的宏。

 NSAssert(myName != nil, @"myName參數(shù)為空");

如果條件判斷為真长捧,則程序繼續(xù)執(zhí)行嚣鄙。

如果判斷條件為假,則拋出異常串结,異常內(nèi)容為后面定義的字符串哑子。

7、if-else超過四層的時候肌割,就要考慮重構(gòu)卧蜓,多層的if-else結(jié)構(gòu)很難維護。(事實上在開發(fā)時很多人都會if else寫一大坨声功,甚至還有很多魔法數(shù)字烦却,讓人看不懂)

8、當(dāng)需要一定條件才執(zhí)行某項操作時先巴,最左邊的應(yīng)該是最重要的代碼其爵,不要將最重要的代碼內(nèi)嵌到if中冒冬。如良好的風(fēng)格是:

- (void) someMethod {
 if(![someOther boolValue]) {
 return;
}
//最重要的代碼寫在這里;
}

反面教材:

- (void) someMethod {
  if([someOther boolValue]) {
      //重要代碼摩渺;
  }
}

9简烤、 UIView的子類初始化的時候,不要進行任何的布局操作摇幻。布局操作應(yīng)該在layoutSubviews里面做横侦;需要重新布局的時候調(diào)用setNeedsLayout,而不要直接調(diào)用layoutSubviews绰姻。(一般代碼創(chuàng)建的時候這樣做)

10枉侧、保持公共API簡單,也就是保持.h文件簡單狂芋。放在.h中聲明的函數(shù)都是會被公開的榨馁,如果根本就沒必要對其他類公開,不要在.h中聲明帜矾。OC中的方法都是公有方法翼虫,沒有私有方法一說。

11屡萤、 推薦方法的第一個花括號直接跟在方法體后珍剑,而不是另起一行,這樣可以減少代碼行死陆。(這個看個人習(xí)慣招拙,我比較推薦這種寫法,而且蘋果默認生成的方法也是這樣)

12翔曲、 推薦方法體中的第一行留空迫像,最后一行不留空劈愚,這樣一個方法就會比較清晰瞳遍。如圖:


1458286863989143.png

但是如果該花括號里面又是一個if,for之類的帶花括號的語句塊菌羽,那么上述的第一行可以不留空掠械。

同樣,如果花括號內(nèi)第一行是注釋的話注祖,第一行也可以不留空猾蒂。注釋也起到了分隔代碼的作用,看起來比較清晰是晨。

再者肚菠,如果花括號內(nèi)只有一行代碼,第一行可以不留空罩缴。

13蚊逢、 由于提到編程經(jīng)驗层扶,就不得不提到版本控制。務(wù)必去學(xué)會SVN或者Git烙荷,就算你是獨立開發(fā)镜会,也要學(xué)會控制自己的代碼,當(dāng)然终抽,你要經(jīng)常備份你的代碼戳表。(這個對代碼的管理比較方便)

上面都是我覺得一些常見的規(guī)范,大家覺得是規(guī)范就可以去遵守昼伴。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末匾旭,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子圃郊,更是在濱河造成了極大的恐慌季率,老刑警劉巖,帶你破解...
    沈念sama閱讀 212,718評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件描沟,死亡現(xiàn)場離奇詭異飒泻,居然都是意外死亡,警方通過查閱死者的電腦和手機吏廉,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,683評論 3 385
  • 文/潘曉璐 我一進店門泞遗,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人席覆,你說我怎么就攤上這事史辙。” “怎么了佩伤?”我有些...
    開封第一講書人閱讀 158,207評論 0 348
  • 文/不壞的土叔 我叫張陵聊倔,是天一觀的道長。 經(jīng)常有香客問我生巡,道長耙蔑,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,755評論 1 284
  • 正文 為了忘掉前任孤荣,我火速辦了婚禮甸陌,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘盐股。我一直安慰自己钱豁,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 65,862評論 6 386
  • 文/花漫 我一把揭開白布疯汁。 她就那樣靜靜地躺著牲尺,像睡著了一般。 火紅的嫁衣襯著肌膚如雪幌蚊。 梳的紋絲不亂的頭發(fā)上谤碳,一...
    開封第一講書人閱讀 50,050評論 1 291
  • 那天凛澎,我揣著相機與錄音,去河邊找鬼估蹄。 笑死塑煎,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的臭蚁。 我是一名探鬼主播最铁,決...
    沈念sama閱讀 39,136評論 3 410
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼垮兑!你這毒婦竟也來了冷尉?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,882評論 0 268
  • 序言:老撾萬榮一對情侶失蹤系枪,失蹤者是張志新(化名)和其女友劉穎雀哨,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體私爷,經(jīng)...
    沈念sama閱讀 44,330評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡雾棺,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,651評論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了衬浑。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片捌浩。...
    茶點故事閱讀 38,789評論 1 341
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖工秩,靈堂內(nèi)的尸體忽然破棺而出尸饺,到底是詐尸還是另有隱情,我是刑警寧澤助币,帶...
    沈念sama閱讀 34,477評論 4 333
  • 正文 年R本政府宣布浪听,位于F島的核電站,受9級特大地震影響眉菱,放射性物質(zhì)發(fā)生泄漏迹栓。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 40,135評論 3 317
  • 文/蒙蒙 一倍谜、第九天 我趴在偏房一處隱蔽的房頂上張望迈螟。 院中可真熱鬧,春花似錦尔崔、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,864評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至消返,卻和暖如春载弄,著一層夾襖步出監(jiān)牢的瞬間耘拇,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,099評論 1 267
  • 我被黑心中介騙來泰國打工宇攻, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留惫叛,地道東北人。 一個月前我還...
    沈念sama閱讀 46,598評論 2 362
  • 正文 我出身青樓逞刷,卻偏偏與公主長得像嘉涌,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子夸浅,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 43,697評論 2 351

推薦閱讀更多精彩內(nèi)容

  • 此文整理是為了方便一些朋友規(guī)范代碼適用于新人(ps:如果你已經(jīng)很規(guī)范的執(zhí)行了那么可以跳過此內(nèi)容)這樣以來如果有...
    無灃閱讀 376評論 0 1
  • 1. 關(guān)于命名 1.1 統(tǒng)一要求 含義清楚仑最,盡量做到不需要注釋也能了解其作用,若做不到帆喇,就加注釋 使用全稱警医,不適用...
    wei_j閱讀 413評論 0 2
  • 一、代碼規(guī)范 1. 命名規(guī)則 1)類名首字母大寫坯钦,方法首字母小寫预皇,方法中的參數(shù)首字母小寫,同時盡量讓方法的命名...
    羅小耳閱讀 688評論 0 7
  • 1. 關(guān)于命名 1.統(tǒng)一要求 含義清楚婉刀,盡量做到不需要注釋也能了解其作用深啤,若做不到,就加注釋路星;使用全稱溯街,不使用縮寫...
    ChinaGoodStaff閱讀 272評論 0 2
  • 環(huán)境 Mac OS X Yosemite Sublime Text 3 MacTeX-2014 Skim 配置 參...
    墨水閱讀 4,073評論 1 4