ios之編碼規範具體說明

標籤：嵌套   尺寸   atom   模組   選擇   目錄   roo   更改   view   

iOS代碼規範：

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

1、project部分：

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

    引用的.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之編碼規範具體說明