iOS程式碼規範

一) 關於命名

• 1> 統一要求

  • 含義清楚，儘量做到不需要註釋也能瞭解其作用，若做不到，就加註釋; 使用全稱，不適用縮寫

• 2> 類的命名

  • 大駝峰式命名：每個單詞的首字母都採用大寫字母, 例子：LYHomePageViewController
    • 字尾要求:
      • ViewController : 使用ViewController做字尾, 例子: MFHomeViewController
      • View : 使用View做字尾, 例子: MFAlertView
      • UITableCell : 使用Cell做字尾, 例子: MFNewsCell
      • Protocol : 使用Delegate或者DataSource作為字尾, 例子: UITableViewDelegate

• 3> 私有變數

  • 小駝峰式命名：第一個單詞以小寫字母開始，後面的單詞的首字母全部大寫. 例子：firstName、lastName
  • 以 _ 開頭，第一個單詞首字母小寫 : 例子：NSString * _somePrivateVariable, 私有變數放在 .m 檔案中宣告

• 4> property變數

  • 小駝峰式命名, 例子：

    ///註釋
    @property (nonatomic, copy) NSString *userName;

• 5> 巨集命名

  • 全部大寫，單詞間用 _ 分隔。[不帶引數]. 例子: #define THIS_IS_AN_MACRO @"THIS_IS_AN_MACRO"
  • 以字母 k 開頭，後面遵循大駝峰命名。[不帶引數]. 例子：#define kWidth self.frame.size.width
  • 小駝峰命名

      #define getImageUrl(url) [NSURL URLWithString:[NSString stringWithFormat:@"%@%@", kBaseUrl,url]]
    

• 6> Enum

  • Enum型別的命名與類的命名規則一致
  • Enum中列舉內容的命名需要以該Enum型別名稱開頭

    typedef NS_ENUM(NSInteger, AFNetworkReachabilityStatus) {
            AFNetworkReachabilityStatusUnknown = -1,
            AFNetworkReachabilityStatusNotReachable = 0,
            AFNetworkReachabilityStatusReachableViaWWAN = 1,
            AFNetworkReachabilityStatusReachableViaWiFi = 2
        };
  

• 7> Delegate命名(遵循蘋果的標準)

  • 類的例項必須為回撥方法的引數之一, 如 : -(NSInteger)tableView:(UITableView*)tableView numberOfRowsInSection:(NSInteger)section
  • 回撥方法的引數只有類自己的情況，方法名要符合實際含義, 如: -(NSInteger)numberOfSectionsInTableView:(UITableView*)tableView
  • 以類的名字開頭(回撥方法存在兩個以上引數的情況)以表明此方法是屬於哪個類的, 如: -(UITableViewCell*)tableView:(UITableView*)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath
  • 使用did和will通知Delegate已經發生的變化或將要發生的變化, 如: -(NSIndexPath*)tableView:(UITableView*)tableView willSelectRowAtIndexPath:(NSIndexPath*)indexPath; -(void)tableView:(UITableView*)tableView didSelectRowAtIndexPath:(NSIndexPath*)indexPath;

• 8> 語法糖

  • 程式碼中使用語法糖，提高寫程式碼效率 :
    • NSArray :

    //NSArray的定義
    NSArray *array = @[@"lu", @"da", @"shi", @YES, @123];
    //NSArray的訪問
    array[index];
    

    • NSDictionary

    //NSDictionary的定義簡化
    NSDictionary *dictionary = @{
        @"key0" : @"value0",
        @"key1" : @"value1",
        @"key2" : @"value2"
    };
    //NSDictionary訪問資料簡化
    dictionary[@"key2"];
    

    • NSNumber

    NSNumber *a = @123;
    NSNumber *b = @11.2;
    NSNumber *c = @('a');
    

二) 私有方法及變數宣告

• 1> 宣告位置

  • 在.m檔案中最上方，定義空的category進行宣告, 例子:

  #import "CodeStandardViewController.h"
  // 在這個category（類目）中定義變數和方法
  @interface CodeStandardViewController ()
  {
  
      // 宣告私有變數
  }
  
  // 私有方法
  - (void)samplePrivateMethod;
  @end
  
  @implementation CodeStandardViewController
  // 私有方法的實現
  - (void)samplePrivateMethod
  {
    //some code
  }
  

• 2> 常量使用

• 常量是容易重複被使用和無需通過查詢和代替就能快速修改值。常量應該使用static來宣告而不是使用#define，除非顯式地使用巨集。

  • 應該:

    static NSString * const RWTAboutViewControllerCompanyName = @"RayWenderlich.com";
    static CGFloat const RWTImageThumbnailHeight = 50.0;
  

  • 不應該:

    #define CompanyName @"RayWenderlich.com"
    #define thumbnailHeight 2
  

三) 關於註釋

  - 最好的程式碼是不需要註釋的 儘量通過合理的命名
  - 良好的程式碼把含義表達清楚 在必要的地方新增註釋
  - 註釋需要與程式碼同步更新
  - 如果做不到命名儘量的見名知意的話，就可以適當的新增一些註釋或者mark

• 1> 屬性註釋

  /// 學生
  @property (nonatomic, strong) Student *student;
  

• 2> 方法宣告註釋：

     /** 
  　　* @brief 登入驗證
  　　*
  　　* @param personId 使用者名稱
  　　* @param password 密碼
  　　* @param complete 執行完畢的block
  　　*
  　　* @return
  　　*/
  + (void)loginWithPersonId:(NSString *)personId password:(NSString *)password complete:(void (^)(CheckLogon *result))complete;
  

四) 關於UI佈局

• 1> 使用Interface Builder進行介面佈局
  • Xib檔案的命名與其對應的.h檔案保持相同
  • Xib檔案中控制元件的組織結構要合理，Xib檔案中控制元件需要有合理的可讀性強的命名，方便他人理解

五) 格式化程式碼

• 1> 指標 "*" 位置

  • 定義一個物件時，指標 "*" 靠近變數. 例子: NSString *userName;

• 2> 方法的宣告和定義

  • 在 - 、+ 和 返回值 之間留一個空格，方法名和第一個引數之間不留空格 : - (id)initWithNibName:(NSString *)nibNameOrNilbundle:(NSBundle *)nibBundleOrNil{...}

• 3> 程式碼縮排

  • 使用 xcode 預設縮排，即 tab = 4空格
  • 使用 xcode 中 re-indent 功能定期對程式碼格式進行整理
  • 相同型別變數宣告需要獨行宣告

    CGFloat oringX = frame.origin.x;
    CGFloat oringY = frame.origin.y;
    CGFloat lineWidth = frame.size.width;
    
    
    // Method與Method之間空一行
    #pragma mark - private methods
    - (void)samplePrivateMethod{...}
    - (void)sampleForIf{...}
    

• 4> 對method進行分組
  • 使用 #pragma mark - 方式對類的方法進行分組, 例子:

    #pragma mark - private methods
    - (void)samplePrivateMethod{...}
    - (void)sampleForIf{...}
    - (void)sampleForWhile{...}
    - (void)sampleForSwitch{...}
    - (void)wrongExamples{...}
  
    #pragma mark - public methods
    - (void)samplePublicMethodWithParam:(NSString*)sampleParam{...}
  
    #pragma mark - life cycle methods
    - (id)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil{...}
    - (void)viewDidLoad{...}
    - (BOOL)shouldAutorotateToInterfaceOrientation:(UIInterfaceOrientation)interfaceOrientation{...}
  

• 5> 大括號寫法
  • 對於類的method: 左括號另起一行寫(遵循蘋果官方文件)

   - (id)initWithNibName:(NSString *)nibNameOrNilbundle:(NSBundle *)nibBundleOrNil{
            self = [super initWithNibName:nibNameOrNil bundle:nibBundleOrNil];
            if (self) {
                        // Custom initialization
            }
            return self;
    }
  

  • 對於其他使用場景: 左括號跟在第一行後邊

   - (void)sampleForIf{
        BOOL someCondition = YES;
        if(someCondition) {
            // do something here
        }
    }
  
        - (void)sampleForWhile{
            int i = 0;
            while (i < 10) {
                // do something here
                i = i + 1;
            }
        }
  

  • 任何需要寫大括號的部分，不得省略, 錯誤示例:

    - (void)wrongExamples{
        BOOLsomeCondition = YES;
        if (someCondition)
            NSLog(@"this is wrong!!!");
        while(someCondition)
            NSLog(@"this is wrong!!!");
    }
  

六) 關於資原始檔

• 原則

  • 採用單詞全拼，或者大家公認無岐義的縮寫(比如：nav，bg，btn等)
  • 採用“模組+功能”命名法，模組分為公共模組、私有模組。公共模組主要包括統一的背景，導航條，標籤，公共的按鈕背景，公共的預設圖等等；私有模組主要根據app的業務
  • 功能模組劃分，比如使用者中心，訊息中心等

• 公共模組命名示例：

  • 導航條背影圖片：bg_nav_bar@2x.png
  • 導航返回按鈕：bg_nav_back_normal@2x.png，bg_nav_back_selected@2x.png
  • 標籤item背景：bg_tabbar_record_normal@2x.png，bg_tabbar_record_selected@2x.png

• 私有模組命名示例：

  以Joggers APP的使用者中心圖片資源為例說明，uc——user center+

  • 使用者中心頭像預設圖：bg_uc_avatar@2x.png
  • 使用者中心頂部預設背景圖：bg_uc_top_defaut@2x.png
  • 使用者中心底部背景圖：bg_uc_bottom@2x.png

• 備註: 這部分工作較為繁雜，並且在程式設計師心中會認為是技術含量較低的一個工作，但圖片命名的嚴謹性同樣會反映出我們對細節的追求，細節決定成敗

七) 補充規範

• 1. 刪除多餘的空行
  • 所有方法與方法之間空1行
  • 所有程式碼塊之間空1行
• 2. 刪除未被使用的資原始檔
• 3. 整體程式碼風格需要統一
  • 程式碼後面的”{“ 不需要單獨佔用一行
  • 邏輯運算子 與 程式碼之前空一格
  • #pragma mark - 與下面的程式碼之前不要空行

• 4.程式碼量控制

  • 單頁程式碼最好控制在800行以內，每個方法最好不要超過80行，過多建議對程式碼進行重構

• 5.及時更新程式碼風格

  • 對其他專案中copy過來的程式碼，根據具體需要更新程式碼風格，及時刪除未被使用的程式碼

• 文章引用

  • http://www.cnblogs.com/gfxxbk/p/5469017.html
  • https://www.jianshu.com/p/f13119c179a4
  • http://www.hudongdong.com/talk/448.html