iOS項(xiàng)目結(jié)構(gòu)和代碼規(guī)范

  • 說兩句
    項(xiàng)目結(jié)構(gòu)和代碼風(fēng)格的重要性對(duì)于一個(gè)團(tuán)隊(duì)和項(xiàng)目來說不言而喻。首先項(xiàng)目結(jié)構(gòu)清晰合理，方便產(chǎn)品的快速迭代以及提高團(tuán)隊(duì)的開發(fā)效率；其次統(tǒng)一的規(guī)范可以促進(jìn)團(tuán)隊(duì)合作，降低維護(hù)成本，以及有助于代碼審查，減少bug處理。
    以下也只是列舉了個(gè)大概，只要養(yǎng)成了良好的代碼習(xí)慣，自然而然就會(huì)不斷的要求自己，提高自己。

一、項(xiàng)目結(jié)構(gòu)

結(jié)構(gòu)如圖所示

iOS項(xiàng)目結(jié)構(gòu).png

結(jié)構(gòu)說明

  1. Classes
  • Extensions - 擴(kuò)展類
  • Common - 項(xiàng)目之間可公用方法
  • Global - 項(xiàng)目?jī)?nèi)公共方法、變量、宏定義
  • Manager - 網(wǎng)絡(luò)請(qǐng)求類、數(shù)據(jù)庫(kù)操作類、緩存操作類
  • Model - 模型
  • ViewModel - 視圖模型(視情況需要增加)
  • Views - 視圖（根據(jù)功能模塊分出Item）
  • Constrollers - 控制器（根據(jù)功能模塊分出Item）
  • Category - 分類
  • Frameworks - 系統(tǒng)的框架
  • Tookis - 引用的第三方

二、Objective-C代碼規(guī)范

目錄

  • 代碼結(jié)構(gòu)
  • 空格
  • 注釋
  • 命名
  • 方法
  • 變量
  • 常量
  • 枚舉
  • 單例模式

代碼結(jié)構(gòu)

//ViewController 生命周期
#pragma mark - Lifecycle
- (void)viewDidLoad {} 
- (void)viewWillAppear:(BOOL)animated {}
- (void)didReceiveMemoryWarning {}

//通知事件
#pragma mark - Notificaion
- (void)keyboardWillAppear:(NSNotification *)aNotification {}

//手勢(shì)方法
#pragma mark - Gesture
- (void)backgroundViewTapGesture:(UITapGestureRecognizer *)sender {}

//按鈕以及其他控件Change事件
#pragma mark - Action
- (IBAction)registerButtonHandler:(id)sender {}

//代理事件
#pragma mark - UITextField Delegate
#pragma mark - UITableView Delegate & DataSource

//私有方法
#pragma mark - Private
- (void)initUI {}  //UI初始化方法
- (void)loadData {}  //加載數(shù)據(jù)方法
- (void)displayInfo {} //加載完UI顯示數(shù)據(jù)方法

- (void)privateMethod {}  //其他私有業(yè)務(wù)邏輯等方法

//共有方法
#pragma mark - Public
- (void)publicMethod {}  //外部調(diào)用方法

空格

  • 縮進(jìn)使用4個(gè)空格，確保在Xcode偏好設(shè)置來設(shè)置。
  • 方法大括號(hào)和其他大括號(hào)(if/else/switch/while 等.)總是在同一行語(yǔ)句打開但在新行中關(guān)閉。
  • 成員變量空格位置
@property (copy, nonatomic) NSString *userName;
  • 方法空格位置
//- 后面 and 參數(shù)名之間 and 第一個(gè)大括號(hào)前 需要一個(gè)空格
 - (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section {
    return 2;
}

注釋

當(dāng)需要注釋時(shí)，注釋應(yīng)該用來解釋這段特殊代碼為什么要這樣做。任何被使用的注釋都必須保持最新或被刪除。

一般都避免使用塊注釋，因?yàn)榇a盡可能做到自解釋，只有當(dāng)斷斷續(xù)續(xù)或幾行代碼時(shí)才需要注釋。例外：這不應(yīng)用在生成文檔的注釋

命名

Apple命名規(guī)則盡可能堅(jiān)持，特別是與這些相關(guān)的memory management rules(NARC)。
長(zhǎng)的，描述性的方法和變量命名是好的。
變量的命名使用駝峰式。

  • 控件命名必須加控件后綴
    應(yīng)該: 
 UIButton *settingsButton;

不應(yīng)該:

UIButton *setBut;
  • 常見變量命名
@property (copy, nonatomic) NSString *userName;
//數(shù)組用List、s、array后綴，推薦List
@property (strong, nonatomic) NSMutableArray *orderList;
//Bool類型用is前綴
@property (assign, nonatomic) BOOL isLogin;
  • 靜態(tài)變量加前綴
    應(yīng)該: 
static NSTimeInterval const RWTTutorialViewControllerNavigationFadeAnimationDuration = 0.3;

不應(yīng)該:

static NSTimeInterval const fadetime = 1.7;
  • Model類命名
    使用項(xiàng)目前綴，如"KB"-> KBUser

方法

在方法簽名中，應(yīng)該在方法類型(-/+ 符號(hào))之后有一個(gè)空格。在方法各個(gè)段之間應(yīng)該也有一個(gè)空格(符合Apple的風(fēng)格)。在參數(shù)之前應(yīng)該包含一個(gè)具有描述性的關(guān)鍵字來描述參數(shù)。
"and"這個(gè)詞的用法應(yīng)該保留。它不應(yīng)該用于多個(gè)參數(shù)來說明，就像initWithWidth:height
以下這個(gè)例子：
應(yīng)該:

- (void)setExampleText:(NSString *)text image:(UIImage *)image;
- (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;
- (id)viewWithTag:(NSInteger)tag;
- (instancetype)initWithWidth:(CGFloat)width height:(CGFloat)height;

不應(yīng)該:

-(void)setT:(NSString *)text i:(UIImage *)image;
- (void)sendAction:(SEL)aSelector :(id)anObject :(BOOL)flag;
- (id)taggedView:(NSInteger)tag;
- (instancetype)initWithWidth:(CGFloat)width andHeight:(CGFloat)height;
- (instancetype)initWith:(int)width and:(int)height; // Never do this.

變量

  • 變量名稱采用英文命名且命名所見即所得，明確變量的意義。不得存在拼音或含糊不清的英文表達(dá)
  • 屬性特征要寫明
@property (copy, nonatomic) NSString *userName;
@property (strong, nonatomic) NSMutableArray *orderList;
@property (assign, nonatomic) BOOL isLogin;

常量

常量首選內(nèi)聯(lián)字符串字面量或數(shù)字，因?yàn)槌Ａ靠梢暂p易重用并且可以快速改變而不需要查找和替換。常量應(yīng)該聲明為 static 常量而不是 #define ，除非非常明確地要當(dāng)做宏來使用。
推薦：

static NSString * const NYTAboutViewControllerCompanyName = @"The New York Times Company";
static const CGFloat NYTImageThumbnailHeight = 50.0;

反對(duì)：

#define CompanyName @"The New York Times Company"
#define thumbnailHeight 2
  • UserDefault Key常量
//UserDefalut Key
//使用前綴 kUDKey標(biāo)明
static NSString * const kUDKeyPrivacySwitchState = @"kUDKeyPrivacySwitchState";
  • Notification Key常量
//Notification Key
//使用小寫k開頭、以及Notification結(jié)尾
static NSString * const kAddDiarySucceedNotificaiton = @"kAddDiarySucceedNotificaiton";

枚舉

使用NS_ENUM進(jìn)行枚舉，加上前綴

typedef NS_ENUM(NSInteger, KBUserSex) {
    KBUserSexMan = 1,          //男
    KBUserSexWoman = 2,        //女
};

單例模式

單例對(duì)象應(yīng)該使用線程安全模式來創(chuàng)建共享實(shí)例。

+ (instancetype)sharedInstance {
  static id sharedInstance = nil;
 
  static dispatch_once_t onceToken;
  dispatch_once(&onceToken, ^{
    sharedInstance = [[self alloc] init];
  });
 
  return sharedInstance;
}
最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • iOS編程規(guī)范0規(guī)范 0.1前言 為??高產(chǎn)品代碼質(zhì)量,指導(dǎo)廣大軟件開發(fā)人員編寫出簡(jiǎn)潔、可維護(hù)、可靠、可 測(cè)試、高效...
    iOS行者閱讀 4,589評(píng)論 21贊 35
  • 推薦文章：禪與 Objective-C 編程藝 前言 為??高產(chǎn)品代碼質(zhì)量,指導(dǎo)廣大軟件開發(fā)人員編寫出簡(jiǎn)潔、可維護(hù)、...
    WolfTin閱讀 2,938評(píng)論 0贊 1
  • 概要 Objective-C是一門面向?qū)ο蟮膭?dòng)態(tài)編程語(yǔ)言，主要用于編寫iOS和Mac應(yīng)用程序。關(guān)于Objectiv...
    DreamMmMmM閱讀 1,271評(píng)論 0贊 7
  • 000
    南朝naasa閱讀 128評(píng)論 0贊 0
  • 1498年，米開朗基羅（Michelangelo）用手中的刻刀記錄下他在世界藝術(shù)史上里程碑式的一頁(yè)。他創(chuàng)作的雕像《...
    Sunny_side閱讀 17,346評(píng)論 3贊 23

友情鏈接更多精彩內(nèi)容