您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發綜合

Google 的 Objective-C 程式碼規範指南

編輯:iOS 開發綜合

良好的程式碼風格是可讀性與可維護性的基礎。本文整理 Google 為 Objective-C 制定的程式碼規範,涵蓋背景、範例、間距格式、命名與註解等各個面向。

背景

Objective-C 是一種動態、物件導向的 C 語言擴充,被設計得易讀且支援複雜的物件導向設計,是 Mac OS X 與 iPhone 上開發新應用的主要語言。Cocoa 則是 Mac OS X 上一個主要的應用框架,提供 Objective-C 類別集合以快速開發完整的應用。

本指南意在結合 Apple 與 Google 的一般建議。閱讀前,建議先讀過 Apple 的 Cocoa 編碼指南與 Google 的開源 C++ 設計指南。要注意:所有在 Google C++ 指南中被禁用的規則,在 Objective-C++ 中同樣適用,除非本文特別指出。

間距與格式

空格與 Tab:僅使用空格,每次縮排 2 個空格。

每行寬度:應盡量把每行控制在 80 個字元以內。

方法的宣告與定義:在 -(或 +)與回傳型別之間需有一個空格;參數列表中,除了參數之間外不要有任何間距。

方法呼叫:格式須與定義時一致;有多種格式化樣式時,採用該原始檔中已使用過的方式。

@public 與 @private:訪問修飾符後需有一個空格。

例外處理:在單獨一行時,@ 標籤與開放大括號之間加一個空格,@catch 與物件捕獲聲明之間也是。

Protocols:型別標識符與被封裝在尖括號中的 protocol 名稱之間不應有空格。

Blocks:Blocks 在建立回呼函式時更傾向於目標選擇器模式,讓程式碼更易讀;區塊內的程式碼應縮排 4 個空格。

命名

Objective-C 的方法命名趨向於較長,但這能帶來良好的閱讀感受,就像讀散文一樣,同時避免不必要的註解。命名主要遵循標準的 Objective-C 規範,採用駝峰命名法(camelCase),這與 C++ 規範中以底線分隔單詞的做法不同。

任何類別、目錄、方法或變數的名字,都應把其中的首字母縮略詞設為大寫,例如 Apple 官方使用的 URL、TIFF 與 EXIF。

在撰寫 Objective-C++ 時,往往無法完全照規範進行。解法是依方法/函式的實作方式決定命名:若在 @implementation 區塊中,就用 Objective-C 規範;若在 C++ 類別中實作方法,就用 C++ 規範,以避免命名規則混用而損害可讀性。

檔案名:應反映其中類別實作的名稱,遵循專案約定且大小寫相關。

類別名(類別與協議名稱):應大寫開頭,並以大小寫混合區分單詞。

分類名稱:應以 2 到 3 個字母的前綴開始,並結合所擴展類別的名稱。

方法名稱:以小寫字母開頭,混合大小寫,每個命名參數也以小寫開頭。

變數名:以小寫字母開頭,混合大小寫;實例變數以前置底線開頭,例如 myLocalVariable、_myInstanceVariable。

註解

註解雖寫起來痛苦,卻對程式碼可讀性至關重要。最好的程式碼都是自註解式的——給變數與型別一個有意義的名字,遠勝過用難懂的名字再費力用註解解釋。寫註解時,要寫給下一位要讀懂你程式碼的貢獻者,多寫一些,下個也許就是你自己。

檔案註解:可在檔案開頭寫一段關於內容的描述。

聲明註解:每個介面、類別、協議的聲明都應有伴隨註解,描述其作用與如何融入整體環境。

實作註解:用豎向排列方式在註解中引用變數名與符號,不要寫成一整行。

物件所有權:當指標所有權模型超出常見用法時,描述得越詳細越好。

Cocoa 與 Objective-C 特性要點

宣告於標頭檔的變數必須標記為 @private;要描述並標識好初始化器;撰寫含 init() 的子類別時,務必重寫父類別的初始化器;建議把重寫 NSObject 的方法放在 @implementation 的上方;不要在 init 中把變數初始化為 0 或 nil,這是多餘的;避免呼叫或重寫 NSObject 的 new() 方法,改用 init 來實例化;保持公開 API 簡單,非必要不公開;引入 Objective-C 標頭檔用 #import,C/C++ 標頭檔用 #include;建立完臨時物件後即釋放;遵循「釋放並保留」規則;在 init 與 dealloc 執行時避免呼叫其他訪問器。

dealloc 中,實例變數應依與 @interface 相同的順序釋放,方便審查;Setter 使用 NSString 時應始終複製其接受的字串;不要 @throw Objective-C 例外,但應準備從第三方或系統呼叫中捕獲;只對邏輯流使用 nil 檢查;將普通整數轉為 BOOL 時要小心,避免直接與 YES 比較。

屬性與 ARC

使用 @property 時,只有宣告 @property 才允許以點語法訪問;介面中除空大括號外不要宣告實例變數;可使用自動合成實例變數;若使用 ARC(Xcode 4.2 以上、僅運行於 64 位元 Mac OS X 10.7 與 iOS 5.0 以上),則優先採用。需要 ARC 的類別應包含預處理指令以防止以手動參考計數編譯。所有權限定符(如 __weak、__unsafe_unretained)應放在變數名之前;屬性則應始終明確指定 strong,而非依賴編譯器預設值。

Cocoa 模式

委派(delegate)物件不應被保留;應將模型從視圖中分離,並將控制器從視圖與模型中分離,使用 @protocol 註解回呼 API。歷史上,實例變數曾使用後綴底線命名。

掌握這些規範,能讓你的 Objective-C 程式碼在團隊協作與長期維護中更加一致、清晰且專業。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved