iOS開發代碼規范

一、代碼規范

1. 命名規則

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

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

? ? 3)宏命名大寫。

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

代理命名規范

2. 注釋

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

注釋分幾類:

1)屬性注釋

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

屬性名、方法名注釋

2)方法集注釋

每個代理的方法可以歸結為一個整體的方法集,在方法集中實現協議的所有代理方法。命名規范:#pragma mark - 方法集名稱,上空兩行,下空一行。

方法集注釋

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

方法集注釋補充說明

3)普通注釋

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

普通注釋

3. 盡可能保證 .h文件的簡潔性,可以不公開的API就不要公開了,寫在實現文件中即可。

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

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

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

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

block代碼規范

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

7.編碼排版格式

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

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

系統的常用類作實例變量聲明加后綴

二、類代碼組織原則

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

示例:

1.系統生命周期函數方法


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

三、補充說明

1. 刪除多余的空行

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

* 所有代碼塊之間空1行

2. 刪除多余的注釋

* 刪除注釋掉的代碼

* 刪除沒有意義的注釋

3. 刪除多余的方法

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

* 如果方法沒有執行任何業務邏輯,請刪除它或者給出一定注釋

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

5. 添加必要的注釋

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

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

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

* 所有代碼中出現的阿拉伯數字需要給出注釋

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

6. 整體代碼風格需要統一

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

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

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

* 遵循一般性的代碼規范

參考鏈接:iOS開發規范? iOS編程規范? IOS開發編碼及命名規范

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,619評論 6 539
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,155評論 3 425
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,635評論 0 382
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,539評論 1 316
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,255評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,646評論 1 326
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,655評論 3 444
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,838評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,399評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,146評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,338評論 1 372
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,893評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,565評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,983評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,257評論 1 292
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,059評論 3 397
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,296評論 2 376

推薦閱讀更多精彩內容

  • 此文整理是為了方便一些朋友規范代碼適用于新人(ps:如果你已經很規范的執行了那么可以跳過此內容)這樣以來如果有...
    無灃閱讀 385評論 0 1
  • 開發代碼規范 風格推薦 仿照 Cocoa 風格來,使用長命名風格,無論是變量,常量,屬性,方法,類名等都應該盡量取...
    CerasusLand閱讀 509評論 0 2
  • 1. 關于命名 1.1 統一要求 含義清楚,盡量做到不需要注釋也能了解其作用,若做不到,就加注釋 使用全稱,不適用...
    wei_j閱讀 419評論 0 2
  • 關于命名1> 統一要求含義清楚,盡量做到不需要注釋也能了解其作用,若做不到,就加注釋使用全稱,不使用縮寫 2> 類...
    the宇亮閱讀 284評論 0 0
  • 文/袁克林 從南盧到茅山,走的是好久未曾體驗過的水路。掛槳船載著一船的人,挨挨擠擠地向著目的地徐徐進發...
    老人與海or閱讀 207評論 0 1