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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 162,710评论 4 376
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 68,839评论 2 308
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 112,295评论 0 255
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,776评论 0 223
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 53,198评论 3 297
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 41,074评论 1 226
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,200评论 2 322
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,986评论 0 214
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,733评论 1 250
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,877评论 2 254
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,348评论 1 265
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,675评论 3 265
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,393评论 3 246
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,209评论 0 9
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,996评论 0 201
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 36,212评论 2 287
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 36,003评论 2 280

推荐阅读更多精彩内容

  • 一、命名规范 1、统一要求含义清楚,尽量做到不需要注释也能了解其作用,若做不到,就加注释,使用全称,不使用缩写。 ...
    Untils阅读 501评论 0 0
  • 方法声明与定义: 1.星号前统一要求需要输入空格 2.方法体左大括号于方法名的右侧 3.-或者+与返回类型之间需要...
    GilbertW阅读 321评论 0 0
  • iOS编程规范0规范 0.1前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、可靠、可 测试、高效...
    iOS行者阅读 4,380评论 21 35
  • iOS代码规范 1、命名规范 类名首字母大写,方法首字母小写,方法中的参数首字母小写,同时尽量让方法的命名读起来像...
    东岳哥哥阅读 377评论 0 2
  • 设计模式:命令模式 定义:“请求”封装成对象,以便使用不同的请求,队列或者日志来参数化其他对象,命令模式也支持可撤...
    CloudHunter阅读 312评论 0 0