iOS代码规范

对于我而言,为数不多取悦自己的方式就是,发现一片新的大陆,或者将自己的屋子收拾成自己想要的样子。

controller代码分组

在函数分组和protocol/delegate实现中使用#pragma mark -来分类方法,要遵循以下一般结构:

#pragma mark - Lifecycle

- (instancetype)init {}

- (void)viewDidLoad {}  viewDidLoad中做三件事情,一件是addSubView,一件是添加约束initConstraints,一件是初始化数据initDefaultData

- (void)viewWillAppear:(BOOL)animated {}

- (void)dealloc {}

- (void)didReceiveMemoryWarning {}

#pragma mark - Public

- (void)ClassPublicMethod {}  用类名开头

#pragma mark - Private

- (void)privateMethod {}  直接用功能命名方法

#pragma mark - event response

按钮点击,touchBegan等方法

#pragma mark - 系统delegate

#pragma mark - UITextFieldDelegate

#pragma mark - UITableViewDataSource

#pragma mark - UITableViewDelegate

#pragma mark - UIScrollViewDelegate等。

#pragma mark - 自定义delegate

#pragma mark - Private set/get

所有的view都写成属性,用懒加载的形式进行创建。然后只有在添加到父视图的时候,用self.view的形式表示,代表创建,其他情况下用_view,省去走懒加载的方法


其他规范

1、方法大括号和其他大括号(if/else/switch/while 等.)总是在同一行语句打开但在新行中关闭

应该:

if(bool) {

}

不应该:

if(bool)

{

}


2、私有变量应该尽可能代替实例变量的使用。尽管使用实例变量是一种有效的方式,但更偏向于使用属性来保持代码一致性。

应该:

@interface ZYObject : NSObject

@property (strong, nonatomic) NSString *text;

@end

不应该:

@interface ZYObject : NSObject{

     NSString *text;

}


3、所有属性特性应该显式地列出来,有助于新手阅读代码。属性特性的顺序应该是storage、atomicity。

应该:

@property (strong, nonatomic) NSString *name;

不应该:

@property (nonatomic, strong) NSString *name;


4、尽量多使用点语法,而不是用[]的方式去调用,提高代码的简洁性

应该:array.count      不应该:[array count]


5、一个类中的常量建议用const关键字,全局常量建议用#define,他们的区别如下:


const定义的只读变量在程序运行过程中只有一份拷贝(因为它是全局的只读变量,存放在静态区),而#define定义的宏常量在内存中有若干个拷贝。

#define宏是在预编译阶段进行替换,而const修饰的只读变量是在编译的时候确定其值。

#define宏没有类型,而const修饰的只读变量具有特定的类型

注:const只能修饰常量或者常量等式


6、命名规范:(可读性高,防止冲突)不同类中的公有方法和公有属性加前缀,如相册类用PG开头;常量的命名用K开头作为标记;枚举和delegate方法名都要以类名开头,delegate的方法要将调用者自己写在方法的参数中

例如:枚举

typedef NS_ENUM(NSInteger, ZYControllerType) {

    ZYControllerTypeOne,

    ZYControllerTypeTwo,

    ZYControllerTypeThree

};

7、如果BOOL属性的名字是一个形容词,属性就能忽略"is"前缀,但要指定get访问器的惯用名称,例如:

@property (assign, getter=isEditable)BOOLeditable;


8、当访问CGRect里的x, y, width, 或 height时,应该使用CGGeometry函数而不是直接通过结构体来访问。

应该:

CGRect frame = self.view.frame;

CGFloat x = CGRectGetMinX(frame);

CGFloat y = CGRectGetMinY(frame);

CGFloat width = CGRectGetWidth(frame);

CGFloat height = CGRectGetHeight(frame);

CGRect frame = CGRectMake(0.0, 0.0, width, height);

不应该:

CGRect frame = self.view.frame;

CGFloat x = frame.origin.x;

CGFloat y = frame.origin.y;

CGFloat width = frame.size.width;

CGFloat height = frame.size.height;

CGRect frame = (CGRect){ .origin = CGPointZero, .size = frame.size };


9、当使用条件语句编码时,左手边的代码应该是"golden" 或 "happy"路径。也就是不要嵌套if语句,多个返回语句也是OK。

应该:

- (void)someMethod {

    if(![someOther boolValue]) {

        return;

    }

    doSomething

}

不应该:

- (void)someMethod {

    if([someOther boolValue]) {

        doSomething;

    }

}


10、当方法通过引用来返回一个错误参数,判断返回值而不是错误变量。

应该:

NSError *error;

BOOL isSuccess = [self trySomethingWithError:&error];

if (!isSuccess) {

    // Handle Error

}

不应该:

NSError *error;

BOOL isSuccess = [self trySomethingWithError:&error];

if (error) {

    // Handle Error

}

11、创建view的正确姿势

i:重写init方法,并在其中addsubview

ii:重写layoutSubviews方法,并在其中添加约束

iii:  需要动态计算长度的,单行用sizeWithAttributes,多行用boundingRectWithSize

你可能感兴趣的:(iOS代码规范)