Objective-C代码规范(简章)

Objective-C编程规范

格式化

缩进

行缩进使用4个空格,不要使用Tab字符。

在定义变量、变量赋值等一些操作时,如果同时操作的数据较多时,建议采用Tab键排版,使写出来的代码更整洁

方法声明和定

留一个空格在 – 或 + 和返回类型之间,但参数列表里的参数之间不要留间隔。

如果参数过多,推荐每个参数各占一行。使用多行的情况下,以参数前的冒号用于对齐。当第一个关键字比其他的短时,后续行至少缩进四个空格。这样你可以让后续的关键字垂直对齐,而不是用冒号对齐。

方法

方法调用的格式和方法声明时的格式一致,一个方法调用完之后在连续调用,需要添加空格。

操作符和 = 号两边要添加空格。

在id和协议的名字之间不能添加空格。

每个段的开括号({ )写在统一行,标签和开括号间隔一个空格。

排版

头文件里的变量应该按照功能的分类放在一起,不同分类用空行隔开。方法内部,相关联的部分不用或少用空行,不相关联的部分,以一个空行分开。

方法(函数)与方法之间留一空行

实现文件里的方法应该先写在模板自动生成的代码之后,具体来说自己定义的方法应该写在dealloc之后,先写Action方法,再写delegate方法。其他方法方法写在最后面。然后用#pragma mark – Buttons action区分开。

deallco中保持和声明的顺序一致,并使用release释放。

命名

所有类,类别, 方法,以及变量如包括缩写,则缩写部分使用全大写的缩写(Initialisms )形式。

文件命名

尽量让文件名和类名相同并反映了它所包含的实现类的名字,如SettingsViewController(继承自UIViewController),DetailsView(继承自UIView)。

类别的文件名应该包含扩展类的名字,比如NSString+Utils.h。

同文件名保持一致,类名应该用大写开头的驼峰命名法。

在应用级别的代码里,尽量不要使用带前缀的类名。每个类都有相同的前缀不能提高可读性。不过如果是编写多个应用间的共享代码,推荐使用前缀。

量名

变量名使用小写开头的驼峰法,类成员变量名开头加一个下划线。

常量(预定义,枚举,局部常量等)使用小写k开头的驼峰法。

方法名

尽量让方法名读起来像一句话

方法使用小写开头的驼峰法命名,每个参数都应该小写开头。

Objective-C特性

特性

使用 property来管理内存,对NSString 的属性,一定要用copy,对delegate一定要用assign。类内部应调用属性方法,用.操作符。

初始化

不需要在初始化的时候设置一个对象为0 或者设置为nil ,对象初始化的时候会自动设置为nil。

子类化如要重写初始化,应重写所有的初始化函数。

员变应该义为@private

使用框架根

如要使用UIView,应该导入UIKit.h

尽量使用//而不要使用/*  */

写公用接口时必需在头文件按标准格式写注释,注释规范再行商定

修改代

更改别人代码时,应该尽量用注释,而不是直接删除,同时写上自己的名字,时间,大概做了怎样的修改示例

逻辑

BOOL值的判断用if  (boolValue) ,不要用if  (boolValue == YES)

== 运算符应把常量写左边,变量写右边。

Float类型不要直接与0比较。

其他原

应该减少模块之间的关联,不要包含多余的头文件

m文件中import,头文件用@class

头文件要尽可能简洁。

#import 和 #include先系统的,再第三方库,再自己的文件

函数最好不要超过100行代码。

Group保持一致

第三方库放入Supports文件夹

Xib文件和类文件放一起

标签: ,
文章分类 iPhone应用开发

发表评论