您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 基礎知識 >> iOS 基礎知識

iOS 基礎:良好的編碼規範

編輯:iOS 基礎知識

養成良好的編碼習慣,是學習一門新語言的首要前提。以下從文檔結構、命名規範到編碼習慣,整理一份實用的 iOS 開發約定。

(一)文檔結構規範

1. 建立 Libs 文件夾,存放第三方庫;

2. 建立 Tools 文件夾,存放自己封裝的類庫;

3. 建立 ViewControllers 文件夾,存放所有 ViewController;

4. 建立 Request 文件夾,存放網路請求;

5. 建立 Cell 文件夾,存放列表 item;

6. 在 Supporting Files 下建立 Images、Music、Video 等文件夾,分別存放圖片、音訊、影片資源;

7. 建立 RootViewController 作為首頁,放在底層目錄;

8. 建立 Constant.h 放在底層目錄,存放常量。

範例如下:

(二)命名規範

1. 常量名全大寫,可用底線分隔,如:MY_LOTTERY_ID;

2. 變數首字母小寫,後面單詞首字母大寫,如 myLotteryId;

3. 類名首字母大寫,如 @interface MyLotteryId : NSObject;

4. 命名時帶上類型標示,如 xxxView、xxxLbl、xxxStr 等。常見類型簡寫如下:

UIViewController:VC   UIImage:Img      UIImageView:Iv
UIView:View           UILabel:Lbl      UIButton:Btn
UINavigationBar:NBar  UIToolBar:TBar   UISearchBar:SBar
UITextField:Tf        UITextView:Tv    NSArray:Array
NSMutableArray:MArray NSDictionary:Dict NSMutableDictionary:MDict
NSString:Str          NSMutableString:MStr
NSSet:Set             NSMutableSet:MSet

5. 靜態變數前加 s 標示,如 sLotteryId。

更多命名規範可參考 Apple 官方文件。

(三)編碼習慣

1. 每個文件前簡要描述該文件的作用;

2. 類中用 #pragma mark - 劃分功能模塊,方便查找與管理;

3. NSLog 測試完統一刪除;

4. 變數與方法名盡量以命名標示功能,無法標示的用註解說明;

5. 在 pch 檔中做加載預處理與 log 自動去除設定;

6. 類程式碼盡量不超過 300 行、單一函數不超過 100 行,超過則考慮重構;

7. 建立 Constant.h 存放常量。

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