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

提升程式品質的 Objective-C 編碼規範指南

編輯:iOS 開發基礎

Objective-C 編碼規範:讓程式碼更有質感

良好的編碼風格不只是視覺上的整齊,更是團隊協作、維護成本與線上穩定性的基礎。以下從 import、前向聲明、屬性、方法、註釋、命名、記憶體管理到常見寫法,整理一套實用的 Objective-C 規範。

一、頭文件與宣告

import 順序

建議先系統庫、再第三方庫、最後專案內類別,且群組之間不要插入多餘空行。

建議寫法

不建議寫法

@class 前向聲明

格式建議為 @class class1, class2;,讓宣告更精簡,也能減少不必要的依賴。

@interface

@interface 與類名之間保留一個空格;類名、父類、協議之間以冒號與逗號清楚分隔。

@protocol

協議名稱與關鍵字、其他協議之間都要保留空格,避免視覺擁擠。

@property

關鍵字以逗號加空格分隔,類型與星號、變量名稱之間也要有合適空格。

property 關鍵字選擇

物件通常使用 strong;基本類型使用 assign;XIB 控制項與代理使用 weak;字符串與 block 使用 copy。需要避免循環引用或明確所有權時,也要依語意選擇 weak 或 copy。

二、方法、常數與註釋

頭文件方法排版

方法簽名盡量保持一行可讀,方法之間留一行,@interface 與第一個方法、最後一個方法與 @end 之間也保留空行。

const 字符串命名

常數建議以 k 開頭,例如 kCVMNoticationUpdateCartList、kGBHomeItemTableViewCellIdentifier,藉此降低命名衝突。

const 字符串位置

若需跨類使用,可在 h 宣告、m 實現;UIKit 使用 UIKIT_EXTERN,Foundation 使用 FOUNDATION_EXTERN。若只在本類使用,只需在 m 中實現。

方法長度與註釋

單個方法建議控制在五十行內,超過時應拆分。屬性用途、方法用途、參數、預設值、邏輯判斷與跳轉都應註釋。

readonly 與 @class

不允許外部修改的屬性應宣告 readonly。頭文件中引用其他類時,優先使用 @class 前向聲明,避免循環 import。

三、可讀性與排版

pragma mark 分組

可依屬性用途、方法功能、代理、Get/Set、初始化等進行分組。

BOOL 屬性

set 方法不要帶 is,get 方法帶 is。

命名與符號

避免用 init、set 作為一般方法前綴;大括號、運算符、物件調用、方法參數連接都要保持清晰空格。

if 條件與 enum

複雜 if 條件建議提取變量,方便斷點與閱讀。enum 應放在對應類別,並使用 NS_ENUM 定義。

四、初始化、型別與變量

初始化方法

盡量使用類別對應的初始化方法,例如 UIView、UIViewController 的專用初始化,避免系統預設屬性未被正確設置。

NSString const 與 define

對應系統模組的字符串常數應使用合適型別;#define 宏建議全大寫並以底線分隔。

m 內部 const、局部變量與駝峰命名

只在 m 內部使用的 const 可加上 static。局部變量建議初始化,變量名使用駝峰命名。

五、屬性賦值、Block 與集合

屬性賦值與 NS_OPTIONS

賦值時避免直接調用 set 方法;NS_OPTIONS 多個值用 | 連接,不能用 +。

Block 命名與循環引用

Block 名稱可用 Block 結尾;block 內若可能循環引用,建議 weakify、strongify。

NSUserDefaults、initialize/load、通知

使用 NSUserDefaults 前先建立物件;避免在 initialize、load 做過多重初始化;通知在 dealloc 中移除監聽。

六、判斷、key、參數與布局

判斷與 key 定義

判斷不要全部擠在一行;取值與存值 key 建議定義,方便重構。

方法參數與布局協議

方法參數連接不要有空格;可透過 GBInitViewProtocol 統一布局與約束設定。

懶加載與界面框架

屬性盡量使用懶加載,並放在 Getter mark 下方。界面元素可獨立到 UIView,ViewController 負責跳轉,ViewModel 負責數據,API 負責請求,Model 負責解析。

七、字面量、常數與枚舉

多使用字面量:字符串、NSNumber、字典、數組。多用類型常量,少用 define;狀態與選項使用枚舉。

八、類族、前綴與初始化

多使用類族,類名加上前綴避免衝突,並提供全能初始化方法。

九、不可變對象、Block/代理與分類

盡可能使用不可變對象;Block 適合一次性異步回調,代理適合持續監聽或數據源。記得在 dealloc 釋放通知與 KVO。按功能劃分分類,第三方類分類加前綴,分類中盡量少用屬性。

十、容錯、單例、遍歷與緩存

不確定的後台資料可用 try catch 或 Model 庫;單例使用 dispatch_once;遍歷數組與字典可用 for-in,需要索引時用 enumerator;緩存使用 NSCache。

十一、條件表達式與錯誤處理

推薦尤達表達式、nil 與 BOOL 檢查、黃金大道、複雜表達式拆分、三元運算符與錯誤處理。檢查 error 時應優先看返回值。

十二、集合元素型別與垂直排版

數組與字典最好指定元素型別,元素垂直書寫更易讀。

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