iOS开发代码规范

2016-03-15 本文已影响392人罗小耳

一、代码规范

1. 命名规则

1）类名首字母大写，方法首字母小写，方法中的参数首字母小写，同时尽量让方法的命名读起来像一句话，能够传达出方法的意思。

2）常量和变量命名小写字母开头，采用“驼峰命名法”，并且要做到见名知其意。

3）宏命名大写。

4）代理名称：类名+Delegate 代理方发名称: 类名+方法实际意义

代理命名规范

2. 注释

注释分几类：

1）属性注释

属性注释使用 /** 注释*/ 的文档注释格式。这种注释相较于// 注释的优点是此属性可以在后面的引用时，在智能提示的下方显示中文注释。

属性名、方法名注释

2）方法集注释

每个代理的方法可以归结为一个整体的方法集，在方法集中实现协议的所有代理方法。命名规范：#pragma mark - 方法集名称，上空两行，下空一行。

方法集注释

补充说明：系统自带方法集注释为#pragma mark ，平时自己使用时尽量在后面加上-，即#pragma mark -，这样注释的方法集会有一条分割线，方便查找代码时分隔开不同的方法集。使用方式见下图

方法集注释补充说明

3）普通注释

在项目中的某个地方的逻辑可能比较复杂或者是核心思想的代码，这种地方应加上一些注释作为标注，也利于自己维护代码，利于之后别人接手代码。

普通注释

3. 尽可能保证 .h文件的简洁性，可以不公开的API就不要公开了，写在实现文件中即可。

4. 实例变量声明时变量名前面加下划线“_”，局部变量不用加。

实例变量声明

局部变量声明

5. 写delegate的时候类型应该为weak弱引用，以避免循环引用，当delegate对象不存在后，我们写的delegate也就没有存在意义了自然是需要销毁的。

6. 使用Block时，内容四个空格缩进，“^”后带有参数时，参数与“{”之间有一个空格缩进

block代码规范

补充说明：若要调整整个.m的代码规范，也可以全选，然后 “control+i” 快捷键缩进空格。

7.编码排版格式

编码排版图1

编码排版图2

编码排版图3

编码排版图4

8. 对于系统的常用类作实例变量声明时加入后缀：

系统的常用类作实例变量声明加后缀

二、类代码组织原则

一个原则：析构函数- (void)dealloc最好放到类最上面，第一眼就可以看到这个方法，可以方便看到是否remove了一些操作，对内存的合理释放等，controller，view的生命周期函数放到最上面，自己实现的方法在下面，相同/相近功能的方法采用#pragma mark -来标记，以便查看。

示例：