ios之編碼規範詳細說明

標籤：ios之編碼規範詳細說明

iOS代碼規範：

所有代碼規範全部遵循蘋果sdk的原則，不清楚的請訪問蘋果SDK文檔或下載官方Demo查看。

1、工程部分：

    將項目中每個功能模組對應的源檔案放入同一檔案夾下，使用虛擬資料夾。

    引用的.a和相關的檔案，獨立使用檔案夾存放，並標明是SDK

2、類：

    命名：首字母大寫，其後每個單字首大寫，類檔案的名字必須與類中主要的@interface類名字一致。（例：RootViewController，PersonInfo）

    category和protocol可以放在獨立檔案中，或放在某個類之前。

3、代碼：

    變數：所有變數命名遵循駝峰規則，變數名需保證見名知意，（例：NSString *personName = @"123",BOOL isTrue = YES）

除此之外還需滿足以下條件：

    臨時變數以小寫字母開頭，其後每個單詞首字母全部大寫，盡量不使用數字和底線。

    全域變數以底線開頭，禁止使用數字，盡量不在中間使用底線。

    

4、資料類型：

    能使用Objective-C的資料類型，盡量使用Objective-C的資料類型，切忌交叉使用（哪怕你知道那原本就是一個類型）。

5、屬性、方法

    所有屬性名稱不能以底線開頭，盡量不使用單詞簡寫。（例：

@property (nonatomic,strong)NSString *orderNumber;

@property (nonatomic,strong)NSMutableDictionary *studentInfo;

）

    方法名必須以小寫字母開頭，每個參數描述必須明確的描述後面的參數，每個形參必須確切的表示參數的作用，嚴禁出現  - (id)init:(NSString *)a b:(NSString *)b作此類的方法名。

6、語句、括弧

      所有語句必須遵循靠左對齊原則，括弧位置需保持一致。

      換行前注意語句對齊，嵌套語句中換行和括弧必須依次縮排。

7、 注釋、標記

     每個不夠明確的變數和屬性之前，必須加上相關注釋。

     每個稍微複雜的方法，必須加上對功能的描述。

     執行到關鍵步驟時，盡量使用語句提示其作用。

     出現關鍵性的流程選擇時，使用注釋提示。

     同一個類中出現其他引用，出現獨立功能模組時，添加mark。

     任意待最佳化、未完善、未測試、不確定的代碼，需要添加mark。

     

8、宏、靜態全域變數

     盡量寫在獨立的檔案中。

     簡短的宏命令盡量使用大寫，稍長的可以大寫開頭，其後使用小寫，但盡量添加底線加以區分。

     大量重複使用的數值盡量使用宏，嵌套層數過多、使用頻率較高、格式固定無需較大更改的方法盡量使用宏。

     常用裝置資訊、螢幕尺寸、固定參數盡量使用宏，介面地址、路徑、固定參數可使用宏或全域靜態變數。

ios之編碼規範詳細說明