Objective-C代码开发规范篇

下面直接进入正题,撸起来。。。

类命名:

1、类名应该用大写开头的驼峰命名法。例如MyTableView、HomeViewController。

2、尽量使用能够反映类功能的名词短语,另外文件和类要同名。

3、在应用程序级别的代码中,尽量不要使用带前缀的类名。每个类都有相同的前缀不能提高可读性。如果是编写多个应用程序间的共用代码,那么需要为类名加上前缀。

4、如果是视图控制器的子类应该添加后缀“ViewController”或者“Controller”,如果是视图的子类则应该添加具体视图的后缀,例如SettingsView、SettingButton、UserNameLabel等。

Category命名:

1、Category的命名应该包含2-3个字符的前缀,用于说明Category是属于具体的某个工程。

2、命名时候应该与类名相同,需要通过+号进行连接,例如:NSString+URLEncoding等。

协议(委托)命名

1、应该与类名相同,此外要添加Delegate后缀。

方法命名

1、小写字母开头,混合大小写。每个命名参数也应该以小写字母开头。

2、方法名使用能够表明方法目的的动词短语。

3、声明方法时,在-或+与返回类型之前应该留一个空格的间距,星号(*)前应该加空格。

4、如果参数过多,每个参数占一行,多个参数时候,每行参数前的冒号对齐。

5、当第一行的函数关键字比其后面行的关键字短时,后面的行应缩进四个空格。保证后续的关键字垂直对齐,而不应该采用冒号对齐的方式。

方法参数命名:

1、首字母小写,之后每个单词字母大写。

2、具有足够的说明下,不需要添加类型前缀。

变量命名:

1、变量名应使用小写字母开头的驼峰法命名。

2、类成员变量应该以一个下划线开始。

3、常量(预定义,枚举,局部常量等)使用小写k开头的驼峰法。枚举类型命名首字母大写,之后每个单词首字母都大写,最后加“s”。 枚举变量使用枚举类型去掉“s”作为前缀,每个单词首字母大写,中间不允许加下划线。

4、控件类变量应该添加类型后缀,表明类型。例如:loginButton,footerView等。

图片命名:

1、使用英文,添加模块名作为前缀,并表明类型,按模块分组存放,并注意@2x、@3x的命名。例如项目名_login_button_bg.png、模块名_user_portrait_icon.png等。

2、ICON和Default启动图之类的请遵守Apple规则。

分组命名:

1、使用英文,首字母大写,之后每个单词首字母大写。

2、每个分组使用模块的名字,开源库统一放在一个文件夹下,例如“Library”

3、公共类库统一放在一个分组下,例如“Common”

4、每个分组都包括特定且类似功能的文件。

书写规范-注释:

1、文件都包含文件头,要说明文件名、作者、创建时间、变更记录。

2、多人协作完成项目时,public接口的每个方法都应该添加关于函数,参数,返回值以及副作用的注释。

3、当if语句的判断条件复杂时,需要用注释说明判断内容。

4、接口类(继承于BaseClient)的头文件每个方法前都应该注明方法的作用。

5、详细注释书写方式请参照另一篇文章《iOS注释那些事儿》

参考文章:

26个方面解决iOS开发问题

Objective-C 编码规范

Google的Objective-C代码规范指南

iOS代码规范

Objective-C编码规范

尊重原创内容,转载请注明出处
本文链接地址: http://www.awnlab.com/archives/5

为您推荐

发表评论

电子邮件地址不会被公开。 必填项已用*标注