Objective-C的编码风格

按Objc编码的风格规范写代码,是一个不随意写代码的程序员应该秉持的良好习惯。本文的代码规范,均参考Apple官方源代码风格,整理并学习。

变量/属性..

官方写法:@property(nullable,nonatomic,weak,readonly) UIViewController *parentViewController;

总结:

  1. 对象变量属性的顺序是:(为空判断, 原子性, 强/弱/拷贝, 读写权限)。源码中的顺序不是严格遵从这一顺序,但是这种顺序可读性好,便于修改,得到CN程序员的广泛认可。

  2. 星号*在变量名称前紧跟,不是在类型声明后。

  3. 变量名称采用全英文不缩写,首字母小写,驼峰命名方式。不应该parentVC等缩写。

  4. 注意上面代码的空格分隔风格。

方法/代理/Block..

官方写法:- (void)viewWillAppear:(BOOL)animated;

总结:

  1. 函数名称采用首字母小写,驼峰命名,英文不缩写的方式。

  2. 方法类型的+、-标识符后紧跟一个空格。


官方写法:- (void)insertSubview:(UIView *)view atIndex:(NSInteger)index;

总结:

  1. 函数命名采用insertXXXX: atXXXX:的方式,明确表达函数意图。不适用and做为函数的名称连接词。苹果代码接口中常见的多参数命名包括:(insert..below..),(insert..above..),(convert..to..),(convert..from..)

  2. 参数不使用缩写或者无意义的变量,做到看参数名称,即可知道应该传递什么样的参数。

类/继承..

官方写法:@interface UIViewController : UIResponder <NSCoding, UIAppearanceContainer, UITraitEnvironment, UIContentContainer, UIFocusEnvironment>

总结:

  1. 继承父类,使用冒号表示,冒号左右各有一个空格。

  2. 协议声明的尖括号需要与父类有一个空格。

  3. 尖括号内部的协议需要用:协议名称、逗号、空格分隔。注意观察风格。

宏..

官方写法:#define TARGET_OS_IPHONE 1

总结:

  1. 宏名称采用英文字母全部大写,单词之间使用下划线分隔。

注释..

官方写法:

效果

  1. 代码注释主要是在代码顶部的行进行注释,分为单行注释,多行注释。单行注释也可以跟在代码尾部,使用若干空格隔开即可。

  2. 注释双斜杠后跟上一个空格隔开,再写注释。

  3. 注释保证有效性,准确性,删除没有时效性的过时注释等。

文章来自 http://skymonkey.cn/

高能广告区

暂无广告哦=^^=。继续看看其它文章吧!