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

一、代碼規(guī)范

1. 命名規(guī)則

? ? 1)類名首字母大寫,方法首字母小寫衷掷,方法中的參數首字母小寫懦胞,同時盡量讓方法的命名讀起來像一句話教藻,能夠傳達出方法的意思。?

? ? 2)常量和變量命名小寫字母開頭,采用“駝峰命名法”,并且要做到見名知其意。

? ? 3)宏命名大寫。

? ? 4)代理名稱:類名+Delegate ? ? ? ? ? ? ? ? ? ?代理方發(fā)名稱: ?類名+方法實際意義

代理命名規(guī)范

2. 注釋

? ? ? 注釋很重要,但除了開頭的版權聲明,盡可能把代碼寫的如同文檔一樣蜀备,讓別人直接看代碼就知道意思关摇。(iOS端項目注釋規(guī)范附統(tǒng)一代碼塊)

注釋分幾類:

1)屬性注釋

屬性注釋 使用 /** 注釋*/ 的文檔注釋格式。 這種注釋相較于// 注釋的優(yōu)點是此屬性可以在后面的引用時碾阁,在智能提示的下方顯示中文注釋输虱。

屬性名、方法名注釋

2)方法集注釋

每個代理的方法可以歸結為一個整體的方法集脂凶,在方法集中實現(xiàn)協(xié)議的所有代理方法宪睹。命名規(guī)范:#pragma mark - 方法集名稱,上空兩行蚕钦,下空一行亭病。

方法集注釋

補充說明:系統(tǒng)自帶方法集注釋為#pragma mark ,平時自己使用時盡量在后面加上-嘶居,即#pragma? mark -罪帖,這樣注釋的方法集會有一條分割線,方便查找代碼時分隔開不同的方法集。使用方式見下圖

方法集注釋補充說明

3)普通注釋

在項目中的某個地方的邏輯可能比較復雜或者是核心思想的代碼整袁,這種地方應加上一些注釋作為標注菠齿,也利于自己維護代碼,利于之后別人接手代碼坐昙。

普通注釋

3. 盡可能保證 .h文件的簡潔性绳匀,可以不公開的API就不要公開了,寫在實現(xiàn)文件中即可炸客。

4. 實例變量聲明時變量名前面加下劃線“_”襟士,局部變量不用加。

實例變量聲明
局部變量聲明

5. 寫delegate的時候類型應該為weak弱引用嚷量,以避免循環(huán)引用陋桂,當delegate對象不存在后,我們寫的delegate也就沒有存在意義了自然是需要銷毀的蝶溶。

6. 使用Block時嗜历,內容四個空格縮進,“^”后帶有參數時抖所,參數與“{”之間有一個空格縮進

block代碼規(guī)范

補充說明:若要調整整個.m的代碼規(guī)范梨州,也可以全選,然后 ?“control+i” ?快捷鍵縮進空格田轧。

7.編碼排版格式

編碼排版 ?圖1
編碼排版? 圖2
編碼排版? 圖3
編碼排版? 圖4

8. 對于系統(tǒng)的常用類作實例變量聲明時加入后綴:

系統(tǒng)的常用類作實例變量聲明加后綴

二暴匠、類代碼組織原則

一個原則:析構函數- (void)dealloc最好放到類最上面,第一眼就可以看到這個方法傻粘,可以方便看到是否remove了一些操作每窖,對內存的合理釋放等,controller弦悉,view的生命周期函數放到最上面窒典,自己實現(xiàn)的方法在下面,相同/相近功能的方法采用#pragma mark -來標記稽莉,以便查看瀑志。

示例:

1.系統(tǒng)生命周期函數方法


2.遵循協(xié)議方法
3.自定義方法聲明
4.網絡數據加載
5.視圖構建方法

三、補充說明

1. 刪除多余的空行

* 所有方法與方法之間空1行

* 所有代碼塊之間空1行

2. 刪除多余的注釋

* 刪除注釋掉的代碼

* 刪除沒有意義的注釋

3. 刪除多余的方法

* 如果方法沒有使用到污秆,請刪除它

* 如果方法沒有執(zhí)行任何業(yè)務邏輯劈猪,請刪除它或者給出一定注釋

4. 刪除未被使用的資源文件

5. 添加必要的注釋

* 所有 .h 文件中的property 需要給出注釋

* 所有自定義的方法需要給出注釋

* 比較大的代碼塊需要給出注釋

* 所有代碼中出現(xiàn)的阿拉伯數字需要給出注釋

* 程序中出現(xiàn)加密/解密 邏輯的操作地方,需要給出注釋說明過程(無論是系統(tǒng)還是自定義)

6. 整體代碼風格需要統(tǒng)一

* 代碼后面的”{“ 不需要單獨占用一行

* 邏輯運算符 與 代碼之前空一格

* “#pragma mark -” 與下面的代碼之前不要空行

* 遵循一般性的代碼規(guī)范

參考鏈接:iOS開發(fā)規(guī)范? iOS編程規(guī)范? IOS開發(fā)編碼及命名規(guī)范

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末良拼,一起剝皮案震驚了整個濱河市战得,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌将饺,老刑警劉巖贡避,帶你破解...
    沈念sama閱讀 217,277評論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件痛黎,死亡現(xiàn)場離奇詭異予弧,居然都是意外死亡刮吧,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,689評論 3 393
  • 文/潘曉璐 我一進店門掖蛤,熙熙樓的掌柜王于貴愁眉苦臉地迎上來杀捻,“玉大人,你說我怎么就攤上這事蚓庭≈录ィ” “怎么了?”我有些...
    開封第一講書人閱讀 163,624評論 0 353
  • 文/不壞的土叔 我叫張陵器赞,是天一觀的道長垢袱。 經常有香客問我,道長港柜,這世上最難降的妖魔是什么请契? 我笑而不...
    開封第一講書人閱讀 58,356評論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮夏醉,結果婚禮上爽锥,老公的妹妹穿的比我還像新娘。我一直安慰自己畔柔,他們只是感情好氯夷,可當我...
    茶點故事閱讀 67,402評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著靶擦,像睡著了一般腮考。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上玄捕,一...
    開封第一講書人閱讀 51,292評論 1 301
  • 那天秸仙,我揣著相機與錄音,去河邊找鬼桩盲。 笑死寂纪,一個胖子當著我的面吹牛,可吹牛的內容都是我干的赌结。 我是一名探鬼主播捞蛋,決...
    沈念sama閱讀 40,135評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼柬姚!你這毒婦竟也來了拟杉?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 38,992評論 0 275
  • 序言:老撾萬榮一對情侶失蹤量承,失蹤者是張志新(化名)和其女友劉穎搬设,沒想到半個月后穴店,有當地人在樹林里發(fā)現(xiàn)了一具尸體,經...
    沈念sama閱讀 45,429評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡拿穴,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,636評論 3 334
  • 正文 我和宋清朗相戀三年泣洞,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片默色。...
    茶點故事閱讀 39,785評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡球凰,死狀恐怖,靈堂內的尸體忽然破棺而出腿宰,到底是詐尸還是另有隱情呕诉,我是刑警寧澤,帶...
    沈念sama閱讀 35,492評論 5 345
  • 正文 年R本政府宣布吃度,位于F島的核電站甩挫,受9級特大地震影響,放射性物質發(fā)生泄漏椿每。R本人自食惡果不足惜伊者,卻給世界環(huán)境...
    茶點故事閱讀 41,092評論 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望拖刃。 院中可真熱鬧删壮,春花似錦、人聲如沸兑牡。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,723評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽均函。三九已至亿虽,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間苞也,已是汗流浹背洛勉。 一陣腳步聲響...
    開封第一講書人閱讀 32,858評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留如迟,地道東北人收毫。 一個月前我還...
    沈念sama閱讀 47,891評論 2 370
  • 正文 我出身青樓,卻偏偏與公主長得像殷勘,于是被迫代替她去往敵國和親此再。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 44,713評論 2 354

推薦閱讀更多精彩內容

  • 此文整理是為了方便一些朋友規(guī)范代碼適用于新人(ps:如果你已經很規(guī)范的執(zhí)行了那么可以跳過此內容)這樣以來如果有...
    無灃閱讀 380評論 0 1
  • 開發(fā)代碼規(guī)范 風格推薦 仿照 Cocoa 風格來玲销,使用長命名風格输拇,無論是變量,常量贤斜,屬性策吠,方法逛裤,類名等都應該盡量取...
    CerasusLand閱讀 496評論 0 2
  • 1. 關于命名 1.1 統(tǒng)一要求 含義清楚,盡量做到不需要注釋也能了解其作用猴抹,若做不到带族,就加注釋 使用全稱,不適用...
    wei_j閱讀 414評論 0 2
  • 關于命名1> 統(tǒng)一要求含義清楚洽糟,盡量做到不需要注釋也能了解其作用炉菲,若做不到堕战,就加注釋使用全稱坤溃,不使用縮寫 2> 類...
    the宇亮閱讀 279評論 0 0
  • 文/袁克林 從南盧到茅山,走的是好久未曾體驗過的水路嘱丢。掛槳船載著一船的人薪介,挨挨擠擠地向著目的地徐徐進發(fā)...
    老人與海or閱讀 198評論 0 1