Objective-C 编码规范
Objective-C 編碼規(guī)范，內(nèi)容來自蘋果、谷歌的文檔翻譯，自己的編碼經(jīng)驗(yàn)和對(duì)其它資料的總結(jié)。?
?
概要
Objective-C 是一門面向?qū)ο蟮膭?dòng)態(tài)編程語言，主要用于編寫 iOS 和 Mac 應(yīng)用程序。關(guān)于 Objective-C 的編碼規(guī)范，蘋果和谷歌都已經(jīng)有很好的總結(jié)：
-
Apple Coding Guidelines for Cocoa
-
Google Objective-C Style Guide
本文主要整合了對(duì)上述文檔的翻譯、作者自己的編程經(jīng)驗(yàn)和其他的相關(guān)資料，為公司總結(jié)出一份通用的編碼規(guī)范。
?
代碼格式
使用空格而不是制表符 Tab
不要在工程里使用 Tab 鍵，使用空格來進(jìn)行縮進(jìn)。在 Xcode > Preferences > Text Editing 將 Tab 和自動(dòng)縮進(jìn)都設(shè)置為?4?個(gè)空格。（Google 的標(biāo)準(zhǔn)是使用兩個(gè)空格來縮進(jìn)，但這里還是推薦使用 Xcode 默認(rèn)的設(shè)置。）?
每一行的最大長度
同樣的，在 Xcode > Preferences > Text Editing > Page guide at column: 中將最大行長設(shè)置為?80?，過長的一行代碼將會(huì)導(dǎo)致可讀性問題。?
函數(shù)的書寫
一個(gè)典型的 Objective-C 函數(shù)應(yīng)該是這樣的：
在 - 和 (void) 之間應(yīng)該有一個(gè)空格，第一個(gè)大括號(hào) { 的位置在函數(shù)所在行的末尾，同樣應(yīng)該有一個(gè)空格。（我司的 C 語言規(guī)范要求是第一個(gè)大括號(hào)單獨(dú)占一行，但考慮到 OC 較長的函數(shù)名和蘋果 SDK 代碼的風(fēng)格，還是將大括號(hào)放在行末。）
如果一個(gè)函數(shù)有特別多的參數(shù)或者名稱很長，應(yīng)該將其按照 : 來對(duì)齊分行顯示：
在分行時(shí)，如果第一段名稱過短，后續(xù)名稱可以以 Tab 的長度（ 4 個(gè)空格）為單位進(jìn)行縮進(jìn)：
函數(shù)調(diào)用?
函數(shù)調(diào)用的格式和書寫差不多，可以按照函數(shù)的長短來選擇寫在一行或者分成多行：
以下寫法是錯(cuò)誤的：
@public?和 @private?標(biāo)記符?
@public 和 @private 標(biāo)記符應(yīng)該以?一個(gè)空格?來進(jìn)行縮進(jìn)：?
協(xié)議（ Protocols?）?
在書寫協(xié)議的時(shí)候注意用<> 括起來的協(xié)議和類型名之間是沒有空格的，比如 IPCConnectHandler()?, 這個(gè)規(guī)則適用所有書寫協(xié)議的地方，包括函數(shù)聲明、類聲明、實(shí)例變量等等：
閉包（ Blocks?）?
根據(jù) block 的長度，有不同的書寫規(guī)則：
-
較短的 block 可以寫在一行內(nèi)。
-
如果分行顯示的話， block 的右括號(hào) } 應(yīng)該和調(diào)用 block 那行代碼的第一個(gè)非空字符對(duì)齊。
-
block 內(nèi)的代碼采用?4?個(gè)空格?的縮進(jìn)。?
-
如果 block 過于龐大，應(yīng)該單獨(dú)聲明成一個(gè)變量來使用。
-
^ 和 ( 之間， ^ 和 { 之間都沒有空格，參數(shù)列表的右括號(hào) ) 和 { 之間有一個(gè)空格。
數(shù)據(jù)結(jié)構(gòu)的語法糖
應(yīng)該使用可讀性更好的語法糖來構(gòu)造 NSArray ， NSDictionary 等數(shù)據(jù)結(jié)構(gòu)，避免使用冗長的 alloc,init 方法。
如果構(gòu)造代碼寫在一行，需要在括號(hào)兩端留有一個(gè)空格，使得被構(gòu)造的元素于與構(gòu)造語法區(qū)分開來：
如果構(gòu)造代碼不寫在一行內(nèi)，構(gòu)造元素需要使用?兩個(gè)空格?來進(jìn)行縮進(jìn)，右括號(hào) ] 或者 } 寫在新的一行，并且與調(diào)用語法糖那行代碼的第一個(gè)非空字符對(duì)齊：?
構(gòu)造字典時(shí)，字典的 Key 和 Value 與中間的冒號(hào) : 都要留有一個(gè)空格，多行書寫時(shí)，也可以將 Value 對(duì)齊：
命名規(guī)范?
基本原則
清晰
命名應(yīng)該盡可能的清晰和簡潔，但在 Objective-C 中，清晰比簡潔更重要。由于 Xcode 強(qiáng)大的自動(dòng)補(bǔ)全功能，我們不必?fù)?dān)心名稱過長的問題。
不要使用單詞的簡寫，拼寫出完整的單詞：然而，有部分單詞簡寫在 Objective-C 編碼過程中是非常常用的，以至于成為了一種規(guī)范，這些簡寫可以在代碼中直接使用，下面列舉了部分：
命名方法或者函數(shù)時(shí)要避免歧義
一致性
整個(gè)工程的命名風(fēng)格要保持一致性，最好和蘋果 SDK 的代碼保持統(tǒng)一。不同類中完成相似功能的方法應(yīng)該叫一樣的名字，比如我們總是用 count 來返回集合的個(gè)數(shù)，不能在 A 類中使用 count 而在 B 類中使用 getNumber 。
?
使用前綴
如果代碼需要打包成 Framework 給別的工程使用，或者工程項(xiàng)目非常龐大，需要拆分成不同的模塊，使用命名前綴是非常有用的。
-
前綴由大寫的字母縮寫組成，比如 Cocoa 中 NS 前綴代表 Founation 框架中的類， IB 則代表 Interface Builder 框架。
-
可以在為類、協(xié)議、函數(shù)、常量以及 typedef 宏命名的時(shí)候使用前綴，但注意?不要為成員變量或者方法使用前綴，因?yàn)樗麄儽旧砭桶陬惖拿臻g內(nèi)。?
-
命名前綴的時(shí)候不要和蘋果 SDK 框架沖突。
?
命名類和協(xié)議（ Class&Protocol?）?
類名以大寫字母開頭，應(yīng)該包含一個(gè)?名詞?來表示它代表的對(duì)象類型，同時(shí)可以加上必要的前綴，比如 NSString,NSDate,NSScanner,NSApplication 等等。?
而協(xié)議名稱應(yīng)該清晰地表示它所執(zhí)行的行為，而且要和類名區(qū)別開來，所以通常使用 ing 詞尾來命名一個(gè)協(xié)議，比如 NSCopying,NSLocking 。
有些協(xié)議本身包含了很多不相關(guān)的功能，主要用來為某一特定類服務(wù)，這時(shí)候可以直接用類名來命名這個(gè)協(xié)議，比如 NSObject 協(xié)議，它包含了 id 對(duì)象在生存周期內(nèi)的一系列方法。
?
命名頭文件（ Headers?）?
源碼的頭文件名應(yīng)該清晰地暗示它的功能和包含的內(nèi)容：
-
如果頭文件內(nèi)只定義了單個(gè)類或者協(xié)議，直接用類名或者協(xié)議名來命名頭文件，比如 NSLocale.h 定義了 NSLocale 類。
-
如果頭文件內(nèi)定義了一系列的類、協(xié)議、類別，使用其中最主要的類名來命名頭文件，比如 NSString.h 定義了 NSString 和 NSMutableString 。
-
每一個(gè) Framework 都應(yīng)該有一個(gè)和框架同名的頭文件，包含了框架中所有公共類頭文件的引用，比如 Foundation.h
-
Framework 中有時(shí)候會(huì)實(shí)現(xiàn)在別的框架中類的類別擴(kuò)展，這樣的文件通常使用被擴(kuò)展的框架名 +Additions 的方式來命名，比如 NSBundleAdditions.h 。
命名方法（ Methods?）?
Objective-C 的方法名通常都比較長，這是為了讓程序有更好地可讀性，按蘋果的說法?“?好的方法名應(yīng)當(dāng)可以以一個(gè)句子的形式朗讀出來 ”?。?
方法一般以小寫字母打頭，每一個(gè)后續(xù)的單詞首字母大寫，方法名中不應(yīng)該有標(biāo)點(diǎn)符號(hào)（?包括下劃線?），有兩個(gè)例外：?
-
可以用一些通用的大寫字母縮寫打頭方法，比如 PDF,TIFF 等。
-
可以用帶下劃線的前綴來命名私有方法或者類別中的方法。
如果方法表示讓對(duì)象執(zhí)行一個(gè)動(dòng)作，使用動(dòng)詞打頭來命名，注意不要使用 do ， does 這種多余的關(guān)鍵字，動(dòng)詞本身的暗示就足夠了：
如果方法是為了獲取對(duì)象的一個(gè)屬性值，直接用屬性名稱來命名這個(gè)方法，注意不要添加 get 或者其他的動(dòng)詞前綴：
對(duì)于有多個(gè)參數(shù)的方法，務(wù)必在每一個(gè)參數(shù)前都添加關(guān)鍵詞，關(guān)鍵詞應(yīng)當(dāng)清晰說明參數(shù)的作用：
不要用 and 來連接兩個(gè)參數(shù)，通常 and 用來表示方法執(zhí)行了兩個(gè)相對(duì)獨(dú)立的操作（從設(shè)計(jì)上來說，這時(shí)候應(yīng)該拆分成兩個(gè)獨(dú)立的方法）：
方法的參數(shù)命名也有一些需要注意的地方 :
-
和方法名類似，參數(shù)的第一個(gè)字母小寫，后面的每一個(gè)單詞首字母大寫
-
不要再方法名中使用類似 pointer,ptr 這樣的字眼去表示指針，參數(shù)本身的類型足以說明
-
不要使用只有一兩個(gè)字母的參數(shù)名
-
不要使用簡寫，拼出完整的單詞
下面列舉了一些常用參數(shù)名：
存取方法（ Accessor Methods?）?
存取方法是指用來獲取和設(shè)置類屬性值的方法，屬性的不同類型，對(duì)應(yīng)著不同的存取方法規(guī)范：
命名存取方法時(shí)不要將動(dòng)詞轉(zhuǎn)化為被動(dòng)形式來使用：
可以使用 can,should,will 等詞來協(xié)助表達(dá)存取方法的意思，但不要使用 do, 和 does ：
為什么 Objective-C 中不適用 get 前綴來表示屬性獲取方法？因?yàn)?get 在 Objective-C 中通常只用來表示從函數(shù)指針返回值的函數(shù)：
命名委托（ Delegate?）?
當(dāng)特定的事件發(fā)生時(shí)，對(duì)象會(huì)觸發(fā)它注冊(cè)的委托方法。委托是 Objective-C 中常用的傳遞消息的方式。委托有它固定的命名范式。
一個(gè)委托方法的第一個(gè)參數(shù)是觸發(fā)它的對(duì)象，第一個(gè)關(guān)鍵詞是觸發(fā)對(duì)象的類名，除非委托方法只有一個(gè)名為 sender 的參數(shù)：
根據(jù)委托方法觸發(fā)的時(shí)機(jī)和目的，使用should,will,did等關(guān)鍵詞
集合操作類方法（ Collection Methods?）?
有些對(duì)象管理著一系列其它對(duì)象或者元素的集合，需要使用類似 “ 增刪查改 ” 的方法來對(duì)集合進(jìn)行操作，這些方法的命名范式一般為：
注意，如果返回的集合是無序的，使用 NSSet 來代替 NSArray 。如果需要將元素插入到特定的位置，使用類似于這樣的命名：
如果管理的集合元素中有指向管理對(duì)象的指針，要設(shè)置成 weak 類型以防止引用循環(huán)。
下面是 SDK 中 NSWindow 類的集合操作方法：
命名函數(shù)（ Functions?）?
在很多場合仍然需要用到函數(shù)，比如說如果一個(gè)對(duì)象是一個(gè)單例，那么應(yīng)該使用函數(shù)來代替類方法執(zhí)行相關(guān)操作。
函數(shù)的命名和方法有一些不同，主要是：
-
函數(shù)名稱一般帶有縮寫前綴，表示方法所在的框架。
-
前綴后的單詞以 “ 駝峰 ” 表示法顯示，第一個(gè)單詞首字母大寫。
函數(shù)名的第一個(gè)單詞通常是一個(gè)動(dòng)詞，表示方法執(zhí)行的操作：
如果函數(shù)返回其參數(shù)的某個(gè)屬性，省略動(dòng)詞：
如果函數(shù)通過指針參數(shù)來返回值，需要在函數(shù)名中使用 Get ：
函數(shù)的返回類型是 BOOL 時(shí)的命名：
命名屬性和實(shí)例變量（ Properties&Instance Variables?）?
屬性和對(duì)象的存取方法相關(guān)聯(lián)，屬性的第一個(gè)字母小寫，后續(xù)單詞首字母大寫，不必添加前綴。屬性按功能命名成名詞或者動(dòng)詞：
屬性也可以命名成形容詞，這時(shí)候通常會(huì)指定一個(gè)帶有 is 前綴的 get 方法來提高可讀性：
命名實(shí)例變量，在變量名前加上 _ 前綴（?有些有歷史的代碼會(huì)將?_?放在后面?），其它和命名屬性一樣：?
一般來說，類需要對(duì)使用者隱藏?cái)?shù)據(jù)存儲(chǔ)的細(xì)節(jié)，所以不要將實(shí)例方法定義成公共可訪問的接口，可以使用 @private ， @protected 前綴。
按蘋果的說法，不建議在除了 init?和 dealloc?方法以外的地方直接訪問實(shí)例變量，但很多人認(rèn)為直接訪問會(huì)讓代碼更加清晰可讀，只在需要計(jì)算或者執(zhí)行操作的時(shí)候才使用存取方法訪問，我就是這種習(xí)慣，所以這里不作要求。
?
命名常量（ Constants?）?
如果要定義一組相關(guān)的常量，盡量使用枚舉類型（ enumerations ），枚舉類型的命名規(guī)則和函數(shù)的命名規(guī)則相同：
使用匿名枚舉定義 bit map ：
使用 const 定義浮點(diǎn)型或者單個(gè)的整數(shù)型常量，如果要定義一組相關(guān)的整數(shù)常量，應(yīng)該優(yōu)先使用枚舉。常量的命名規(guī)范和函數(shù)相同：
不要使用 #define 宏來定義常量，如果是整型常量，盡量使用枚舉，浮點(diǎn)型常量，使用 const 定義。 #define 通常用來給編譯器決定是否編譯某塊代碼，比如常用的：
注意到一般由編譯器定義的宏會(huì)在前后都有一個(gè) __ ，比如?__MACH__?。
?
命名通知（ Notifications?）?
通知常用于在模塊間傳遞消息，所以通知要盡可能地表示出發(fā)生的事件，通知的命名范式是：
栗子：
注釋?
讀沒有注釋代碼的痛苦你我都體會(huì)過，好的注釋不僅能讓人輕松讀懂你的程序，還能提升代碼的逼格。注意注釋是為了讓別人看懂，而不是僅僅你自己。
文件注釋
每一個(gè)文件都?必須?寫文件注釋，文件注釋通常包含?
-
文件所在模塊
-
作者信息
-
歷史版本信息
-
版權(quán)信息
-
文件包含的內(nèi)容，作用
一段良好文件注釋的栗子：
文件注釋的格式通常不作要求，能清晰易讀就可以了，但在整個(gè)工程中風(fēng)格要統(tǒng)一。
代碼注釋
好的代碼應(yīng)該是 “ 自解釋 ” （ self-documenting ）的，但仍然需要詳細(xì)的注釋來說明參數(shù)的意義、返回值、功能以及可能的副作用。
方法、函數(shù)、類、協(xié)議、類別的定義都需要注釋，推薦采用 Apple 的標(biāo)準(zhǔn)注釋風(fēng)格，好處是可以在引用的地方 alt+ 點(diǎn)擊自動(dòng)彈出注釋，非常方便。
有很多可以自動(dòng)生成注釋格式的插件，推薦使用?VVDocumenter?：?
一些良好的注釋：
協(xié)議、委托的注釋要明確說明其被觸發(fā)的條件：
如果在注釋中要引用參數(shù)名或者方法函數(shù)名，使用 || 將參數(shù)或者方法括起來以避免歧義：
定義在頭文件里的接口方法、屬性必須要有注釋！
編碼風(fēng)格
每個(gè)人都有自己的編碼風(fēng)格，這里總結(jié)了一些比較好的 Cocoa 編程風(fēng)格和注意點(diǎn)。
?
不要使用 new?方法?
盡管很多時(shí)候能用 new 代替 alloc init 方法，但這可能會(huì)導(dǎo)致調(diào)試內(nèi)存時(shí)出現(xiàn)不可預(yù)料的問題。 Cocoa 的規(guī)范就是使用 alloc init 方法，使用 new 會(huì)讓一些讀者困惑。
?
Public API?要盡量簡潔?
共有接口要設(shè)計(jì)的簡潔，滿足核心的功能需求就可以了。不要設(shè)計(jì)很少會(huì)被用到，但是參數(shù)極其復(fù)雜的 API 。如果要定義復(fù)雜的方法，使用類別或者類擴(kuò)展。
#import和 #include?
#import 是 Cocoa 中常用的引用頭文件的方式，它能自動(dòng)防止重復(fù)引用文件，什么時(shí)候使用 #import ，什么時(shí)候使用 #include 呢？
-
當(dāng)引用的是一個(gè) Objective-C 或者 Objective-C++ 的頭文件時(shí)，使用 #import
-
當(dāng)引用的是一個(gè) C 或者 C++ 的頭文件時(shí)，使用 #include ，這時(shí)必須要保證被引用的文件提供了保護(hù)域（ #define guard ）。
栗子：
為什么不全部使用 #import 呢？主要是為了保證代碼在不同平臺(tái)間共享時(shí)不出現(xiàn)問題。
引用框架的根頭文件
上面提到過，每一個(gè)框架都會(huì)有一個(gè)和框架同名的頭文件，它包含了框架內(nèi)接口的所有引用，在使用框架的時(shí)候，應(yīng)該直接引用這個(gè)根頭文件，而不是其它子模塊的頭文件，即使是你只用到了其中的一小部分，編譯器會(huì)自動(dòng)完成優(yōu)化的。
BOOL?的使用?
BOOL 在 Objective-C 中被定義為 signed char 類型，這意味著一個(gè) BOOL 類型的變量不僅僅可以表示 YES(1) 和 NO(0) 兩個(gè)值，所以永遠(yuǎn)?不要?將 BOOL 類型變量直接和 YES 比較：?
同樣的，也不要將其它類型的值作為 BOOL 來返回，這種情況下， BOOL 變量只會(huì)取值的最后一個(gè)字節(jié)來賦值，這樣很可能會(huì)取到 0 （ NO ）。但是，一些邏輯操作符比如 &&,||,! 的返回是可以直接賦給 BOOL 的：
另外 BOOL 類型可以和 _Bool,bool 相互轉(zhuǎn)化，但是?不能?和 Boolean 轉(zhuǎn)化。?
使用 ARC
除非想要兼容一些古董級(jí)的機(jī)器和操作系統(tǒng)，我們沒有理由放棄使用 ARC 。在最新版的 Xcode(6.2) 中， ARC 是自動(dòng)打開的，所以直接使用就好了。
?
在 init?和 dealloc?中不要用存取方法訪問實(shí)例變量?
當(dāng) initdealloc 方法被執(zhí)行時(shí)，類的運(yùn)行時(shí)環(huán)境不是處于正常狀態(tài)的，使用存取方法訪問變量可能會(huì)導(dǎo)致不可預(yù)料的結(jié)果，因此應(yīng)當(dāng)在這兩個(gè)方法內(nèi)直接訪問實(shí)例變量。
按照定義的順序釋放資源?
在類或者 Controller 的生命周期結(jié)束時(shí)，往往需要做一些掃尾工作，比如釋放資源，停止線程等，這些掃尾工作的釋放順序應(yīng)當(dāng)與它們的初始化或者定義的順序保持一致。這樣做是為了方便調(diào)試時(shí)尋找錯(cuò)誤，也能防止遺漏。
?
保證 NSString?在賦值時(shí)被復(fù)制?
NSString 非常常用，在它被傳遞或者賦值時(shí)應(yīng)當(dāng)保證是以復(fù)制（ copy ）的方式進(jìn)行的，這樣可以防止在不知情的情況下 String 的值被其它對(duì)象修改。
使用 NSNumber?的語法糖?
使用帶有 @ 符號(hào)的語法糖來生成 NSNumber 對(duì)象能使代碼更簡潔：
nil?檢查?
因?yàn)樵?Objective-C 中向 nil 對(duì)象發(fā)送命令是不會(huì)拋出異?；蛘邔?dǎo)致崩潰的，只是完全的 “ 什么都不干 ” ，所以，只在程序中使用 nil 來做邏輯上的檢查。
另外，不要使用諸如 nil == Object 或者 Object == nil 的形式來判斷。
屬性的線程安全?
定義一個(gè)屬性時(shí)，編譯器會(huì)自動(dòng)生成線程安全的存取方法（ Atomic ），但這樣會(huì)大大降低性能，特別是對(duì)于那些需要頻繁存取的屬性來說，是極大的浪費(fèi)。所以如果定義的屬性不需要線程保護(hù)，記得手動(dòng)添加屬性關(guān)鍵字 nonatomic 來取消編譯器的優(yōu)化。
點(diǎn)分語法的使用
不要用點(diǎn)分語法來調(diào)用方法，只用來訪問屬性。這樣是為了防止代碼可讀性問題。
Delegate?要使用弱引用?
一個(gè)類的 Delegate 對(duì)象通常還引用著類本身，這樣很容易造成引用循環(huán)的問題，所以類的 Delegate 屬性要設(shè)置為弱引用。
轉(zhuǎn)載于:https://www.cnblogs.com/496668219long/p/4488512.html
總結(jié)
以上是生活随笔為你收集整理的Objective-C 编码规范的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
