iOS編碼規(guī)范匯總

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.方法和方法之間要有一空行分割。
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末袭蝗,一起剝皮案震驚了整個濱河市唤殴,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌到腥,老刑警劉巖朵逝,帶你破解...
    沈念sama閱讀 217,542評論 6 504
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異乡范,居然都是意外死亡配名,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,822評論 3 394
  • 文/潘曉璐 我一進(jìn)店門晋辆,熙熙樓的掌柜王于貴愁眉苦臉地迎上來渠脉,“玉大人,你說我怎么就攤上這事栈拖×幔” “怎么了?”我有些...
    開封第一講書人閱讀 163,912評論 0 354
  • 文/不壞的土叔 我叫張陵涩哟,是天一觀的道長索赏。 經(jīng)常有香客問我,道長贴彼,這世上最難降的妖魔是什么潜腻? 我笑而不...
    開封第一講書人閱讀 58,449評論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮器仗,結(jié)果婚禮上融涣,老公的妹妹穿的比我還像新娘。我一直安慰自己精钮,他們只是感情好威鹿,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,500評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著轨香,像睡著了一般忽你。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上臂容,一...
    開封第一講書人閱讀 51,370評論 1 302
  • 那天科雳,我揣著相機(jī)與錄音根蟹,去河邊找鬼。 笑死糟秘,一個胖子當(dāng)著我的面吹牛简逮,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播尿赚,決...
    沈念sama閱讀 40,193評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼散庶,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了吼畏?” 一聲冷哼從身側(cè)響起督赤,我...
    開封第一講書人閱讀 39,074評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎泻蚊,沒想到半個月后躲舌,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,505評論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡性雄,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,722評論 3 335
  • 正文 我和宋清朗相戀三年没卸,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片秒旋。...
    茶點(diǎn)故事閱讀 39,841評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡约计,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出迁筛,到底是詐尸還是另有隱情煤蚌,我是刑警寧澤,帶...
    沈念sama閱讀 35,569評論 5 345
  • 正文 年R本政府宣布细卧,位于F島的核電站尉桩,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏贪庙。R本人自食惡果不足惜蜘犁,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,168評論 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望止邮。 院中可真熱鬧这橙,春花似錦、人聲如沸导披。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,783評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽撩匕。三九已至助隧,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背并村。 一陣腳步聲響...
    開封第一講書人閱讀 32,918評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留滓技,地道東北人哩牍。 一個月前我還...
    沈念sama閱讀 47,962評論 2 370
  • 正文 我出身青樓,卻偏偏與公主長得像令漂,于是被迫代替她去往敵國和親膝昆。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,781評論 2 354