參考:
1、iOS中書(shū)寫(xiě)代碼規(guī)范35條小建議
2逐样、iOS開(kāi)發(fā)總結(jié)之代碼規(guī)范
3蜗字、iOS代碼編程規(guī)范-根據(jù)項(xiàng)目經(jīng)驗(yàn)匯總
代碼結(jié)構(gòu)規(guī)范
1脂新、Model 統(tǒng)一放到App_Model挪捕,建立對(duì)應(yīng)模塊的目錄。服務(wù)器返回?cái)?shù)據(jù)争便,建立model级零。請(qǐng)求參數(shù)也盡量建立RequestObject,放在App_Web/RequestModel滞乙。
2奏纪、功能模塊目錄App_Code。1斩启、每個(gè)模塊建立實(shí)體目錄序调。2、子目錄(實(shí)體目錄):ViewController浇垦、Model炕置、View荣挨、Others男韧。3、子文件可建立虛擬目錄(虛擬目錄可以用中文)默垄。4此虑、view、controler命名加前綴(每個(gè)模塊都要加上自己的前綴口锭,比如相冊(cè)模塊(PhotoGallery)的代碼都以PG作為前綴: PGAlbumViewController, PGDataManager)朦前。
3、第三方庫(kù)使用cocoa pod管理鹃操,使用第三庫(kù)進(jìn)行一層封裝韭寸,放在podLibrary。本地第三方庫(kù)管理荆隘,分類(lèi):SDK恩伺、Tools、ViewControls椰拒、Public晶渠、Modify凰荚。及自己創(chuàng)建的組件。
4褒脯、類(lèi)中功能模塊以#pragma mark – 分割便瑟,上空兩行,下空一行
5番川、不能使用魔法數(shù)字到涂,顏色、常量颁督、key养盗、尺寸、復(fù)用的圖片等統(tǒng)一定義适篙,定義在App_Data往核。可以細(xì)分文件嚷节,方便分離聂儒。
6、數(shù)據(jù)合法性驗(yàn)證硫痰,邏輯必須閉包比如:if--else衩婚。
7、統(tǒng)一工具類(lèi)使用效斑。網(wǎng)絡(luò)請(qǐng)求非春、數(shù)據(jù)緩存、模型轉(zhuǎn)換缓屠、ui組件奇昙、系統(tǒng)分類(lèi)等
8、.h 文件寫(xiě)的所有代碼都盡量寫(xiě)注釋敌完。如果是內(nèi)部使用的屬性, 那么就定義成私有的屬性(定義到.m的class extension里面)
9储耐、commit代碼之前一定要保證木有warning, 木有內(nèi)存泄露, 確保都OK之后再上傳代碼
命名規(guī)范
編碼規(guī)范簡(jiǎn)單來(lái)說(shuō)就是為了保證寫(xiě)出來(lái)的代碼具備三個(gè)原則:可復(fù)用, 易維護(hù), 可擴(kuò)展.