類命名規範

• 常用Foundation類命名規範，通常以型別的縮寫結尾

NSString *someStr;
NSArray *someArray;
NSDictionary *someDict;
NSDate *someDate;
NSTimer *someTimer;

• 常用UIKit類命名規範，通常也是以型別的縮寫結尾

UIView *someView;
UILabel *someLabel;
UIButton *someBtn;
UIImage *someImage;
UIImageView *someImageView;
UITextField *someTextField
 
;
UIViewController *someVC;

檔案書寫規範

• 標頭檔案規範

//
//  ViewController.h
//  程式碼規範
//
//  Created by yaoliangjun on 2018/4/10.
//  Copyright © 2018年 yaoliangjun. All rights reserved.
//  此處需要備註一下是哪個控制器/模型/控制元件

#import <UIKit/UIKit.h>
// 此處保持一個空行
@class SomeModel;
// 此處保持一個空行
@interface ViewController : UIViewController
 
 // 類名的首字母必須大寫，如果有多個單詞以駝峰式命名書寫
// 此處保持一個空行
@property (nonatomic, copy) NSString *someStr;
@property (nonatomic, strong) SomeModel *someModel;
// 此處保持一個空行

// 屬性和方法分開放
- (void)someMethod; // 方法名必須以小寫字母開頭
+ (NSString *)someMethod;
// 此處保持一個空行
@end

- 實現檔案規範

//
//  ViewController.m
//  程式碼規範
//
//  Created by yaoliangjun on 2018/4/10.
 

//  Copyright © 2018年 yaoliangjun. All rights reserved.
//

#import "ViewController.h"
#import "SomeModel.h"
// 此處保持一個空行
@interface ViewController ()
// 此處保持一個空行
@property (nonatomic, copy) NSString *someStr;
@property (nonatomic, assign) int age;
@property (nonatomic, strong) SomeModel *someModel;
// 此處保持一個空行
@end
// 此處保持一個空行
@implementation ViewController
// 此處保持一個空行
#pragma mark - Life Cycle Method -- 放置生命週期方法

#pragma mark - Delegate Method -- 放置代理方法

#pragma mark - Private Method -- 放置私有方法

#pragma mark - Public Method -- 放置公開方法

#pragma mark - Getter/Setter Method -- 放置getter和setter等懶載入方法
// 此處保持一個空行
@end

其他規範

• 代理命名規範

#import <UIKit/UIKit.h>

@class SomeView;

// 代理命名: 以該控制元件名開頭，Delegate結尾
@protocol SomeViewDelegate <NSObject>

// 以控制元件名開頭, 可以參考tableView的代理命名方式
- (void)someView:(SomeView *)someView didSelectedIndexPathAtRow:(NSInteger)row;

@end

@interface SomeView : UIView

@end