CodeReview 代碼評審
1.全部MVVM模式
api和數(shù)據(jù)處理全部放在VM里面處理立磁,M里面不要有業(yè)務(wù)代碼
2.能使用 @class 在.h 川陆,不要 #import
@class XMPerson.h
3.注釋規(guī)范
1.類.h要有說明其用途
2.屬性生命需要用///注釋
/// 聲音標(biāo)題
@property (nonatomic ,copy) NSString *voiceTitle;
3. 內(nèi)容分段用 #param mark - 段內(nèi)用 #param mark
#pragma mark -
#pragma mark - lazy
4.方法注釋需要見名思意
// 設(shè)置無網(wǎng)絡(luò)視圖
- (void)resetNoNetView
4.命名規(guī)范(包括方法命名旺坠、類名、變量名)
1.統(tǒng)一駝峰命名遵蚜,都以模塊前綴開頭
2.變量命名不要單個字符
3.類名末尾要包含此類的類型苦始,比如XMRootView寞钥,XMRootViewController
4.命名原則要表達(dá)出其主要意圖
5.屬性
1.屬性名稱首字母小寫,后續(xù)首字母大寫;
2.使用@property陌选,要保持必要的空格理郑,如:@property (nonatomic, strong)蹄溉;
3.如果在@implementation內(nèi)聲明全局變量,則使用下劃線前綴香浩,局部變量不需要使用下劃線前綴类缤;
4.禁止使用a、b邻吭、c這樣的變量命名餐弱,要見詞達(dá)意;
5.屬性命名時囱晴,要將屬性類型編寫到屬性名中膏蚓,使讀者看到變量名即可知道這是個什么類型的變量,比如:usersDict畸写,usersArray等驮瞧。
6.方法
1.-或者+后加一空格;
- (void)viewDidLoad {
}
2.方法名首字母小寫枯芬,后續(xù)單詞首字母大寫论笔;
- (void)viewDidLoad
3.參數(shù)名首字母小寫,后續(xù)單詞首字母大寫千所;
4.參數(shù)類型如果帶有*號狂魔,則參數(shù)類型和*號之間加一空格;
5.如果方法太長淫痰、參數(shù)過多最楷,可以換行冒號對齊,方法調(diào)用也一樣待错;
6.非重寫系統(tǒng)方法時籽孙,不要使用is、set和get前綴火俄;
7.可以使用 can,should,will等詞來協(xié)助表達(dá)存取方法的意思犯建,但不要使用do和does;
8.不可以省略關(guān)鍵詞瓜客;
9.盡量讓方法的命名讀起來像一句完整的話胎挎,能夠傳達(dá)出方法的意思;
7.使用統(tǒng)一前綴
XMMineSignTaskViewController
8.代碼分模塊
1.代碼分模塊寫忆家,不要寫到公共里面去。能從公共抽出來的東西不要放里面去
9.VC里.m文件結(jié)構(gòu)
生命周期前面德迹、芽卿、通知、tableview胳搞、public卸例、private称杨、懶加載最后
10.方法的封裝
1.方法的單一職責(zé):單個方法的職責(zé)盡量單一,盡量抽離公共邏輯筷转,方法盡量復(fù)用姑原。
2.方法實現(xiàn)行數(shù):一個方法的最大行數(shù)100行,如果一個方法的實現(xiàn)超過一百行呜舒,則說明需要進(jìn)行邏輯拆分了锭汛。
3.方法和方法之間要有一空行分割。