Objective-C代碼規(guī)范

來自 Colinhou的博客

因?yàn)榇a命名不規(guī)范被老大叼了,被同事逼逼了鉴扫。身害。味悄。
我們寫出來的代碼會(huì)給很多人看,為了使代碼清晰簡(jiǎn)潔题造,方便閱讀理解傍菇,都會(huì)統(tǒng)一遵從一定的代碼規(guī)范猾瘸,Objective-C同樣如此界赔。
主要參考規(guī)范:
  1. Google Objective-C Style Guide
  2. Coding Guidelines for Cocoa
  • 代碼行度最大為100列(C++的是80)
  • 聲明類或方法時(shí),注意空格的使用牵触,參數(shù)過多時(shí)可換行保持對(duì)齊淮悼,
  • 調(diào)用方法時(shí)也是如此,參數(shù)都寫在一行或換行冒號(hào)對(duì)齊揽思,
  • 命名規(guī)則

類名首字母大寫袜腥,方法首字母小寫,方法中的參數(shù)首字母小寫钉汗,同時(shí)盡量讓方法的命名讀起來像一句話羹令,能夠傳達(dá)出方法的意思鲤屡,同時(shí)取值方法前不要加前綴“get”

變量名小寫字母開頭

常量以小寫字母k開頭,后續(xù)首字母大寫

  • 關(guān)于注釋

注釋很重要福侈,但除了開頭的版權(quán)聲明酒来,盡可能把代碼寫的如同文檔一樣,讓別人直接看代碼就知道意思肪凛,寫代碼時(shí)別擔(dān)心名字太長(zhǎng)堰汉,相信Xcode的提示功能。

  • 實(shí)例變量應(yīng)該在實(shí)現(xiàn)文件.m中聲明或以@property形式在.h文件中聲明伟墙,一定要直接在.h文件聲明翘鸭,加上@priavte,另外戳葵,使用@private就乓、@public,前面需要一個(gè)縮進(jìn)空格拱烁。

  • 盡可能保證 .h文件的簡(jiǎn)潔性档址,可以不公開的API就不要公開了,寫在實(shí)現(xiàn)文件中即可邻梆。

  • Xcode支持Objective-C/C/C++混編守伸,所以引用頭文件時(shí):#import Ojbective-C/Objective-C++頭文件(Objective-C++是Objective-C與C++混編的文件),#include C/C++頭文件浦妄。

  • 寫delegate的時(shí)候類型應(yīng)該為weak弱引用尼摹,以避免循環(huán)引用,當(dāng)delegate對(duì)象不存在后剂娄,我們寫的delegate也就沒有存在意義了自然是需要銷毀的蠢涝。


  • 實(shí)例變量聲明時(shí)變量名前面加下劃線“_”,局部變量不用加阅懦。

蘋果官方代碼示例命名規(guī)范截圖

  • 使用Block時(shí)和二,內(nèi)容四個(gè)空格縮進(jìn),“^”后帶有參數(shù)時(shí)耳胎,參數(shù)與“{”之間有一個(gè)空格縮進(jìn)
  • 建議使用“#pragma mark”惯吕,方便閱讀代碼
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市怕午,隨后出現(xiàn)的幾起案子废登,更是在濱河造成了極大的恐慌,老刑警劉巖郁惜,帶你破解...
    沈念sama閱讀 207,248評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件堡距,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)羽戒,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,681評(píng)論 2 381
  • 文/潘曉璐 我一進(jìn)店門缤沦,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人易稠,你說我怎么就攤上這事疚俱。” “怎么了缩多?”我有些...
    開封第一講書人閱讀 153,443評(píng)論 0 344
  • 文/不壞的土叔 我叫張陵呆奕,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我衬吆,道長(zhǎng)梁钾,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,475評(píng)論 1 279
  • 正文 為了忘掉前任逊抡,我火速辦了婚禮姆泻,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘冒嫡。我一直安慰自己拇勃,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,458評(píng)論 5 374
  • 文/花漫 我一把揭開白布孝凌。 她就那樣靜靜地躺著方咆,像睡著了一般。 火紅的嫁衣襯著肌膚如雪蟀架。 梳的紋絲不亂的頭發(fā)上瓣赂,一...
    開封第一講書人閱讀 49,185評(píng)論 1 284
  • 那天,我揣著相機(jī)與錄音片拍,去河邊找鬼煌集。 笑死,一個(gè)胖子當(dāng)著我的面吹牛捌省,可吹牛的內(nèi)容都是我干的苫纤。 我是一名探鬼主播,決...
    沈念sama閱讀 38,451評(píng)論 3 401
  • 文/蒼蘭香墨 我猛地睜開眼纲缓,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼卷拘!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起色徘,我...
    開封第一講書人閱讀 37,112評(píng)論 0 261
  • 序言:老撾萬榮一對(duì)情侶失蹤恭金,失蹤者是張志新(化名)和其女友劉穎操禀,沒想到半個(gè)月后褂策,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,609評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,083評(píng)論 2 325
  • 正文 我和宋清朗相戀三年斤寂,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了耿焊。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,163評(píng)論 1 334
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡遍搞,死狀恐怖罗侯,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情溪猿,我是刑警寧澤钩杰,帶...
    沈念sama閱讀 33,803評(píng)論 4 323
  • 正文 年R本政府宣布,位于F島的核電站诊县,受9級(jí)特大地震影響讲弄,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜依痊,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,357評(píng)論 3 307
  • 文/蒙蒙 一避除、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧胸嘁,春花似錦瓶摆、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,357評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至毫胜,卻和暖如春蝌借,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背指蚁。 一陣腳步聲響...
    開封第一講書人閱讀 31,590評(píng)論 1 261
  • 我被黑心中介騙來泰國(guó)打工菩佑, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人凝化。 一個(gè)月前我還...
    沈念sama閱讀 45,636評(píng)論 2 355
  • 正文 我出身青樓稍坯,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親搓劫。 傳聞我的和親對(duì)象是個(gè)殘疾皇子瞧哟,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,925評(píng)論 2 344

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