IOS开发编码及命名规范

目录
1、目的
2、适用范围
3、编码规范
3.1、文件
3.2、注释
3.3、编码排版格式
3.4、命名规范
3.4.1、保留字
3.4.2、方法
3.4.3、变量
3.4.4、常量
3.4.5、类
3.5、修改规范
3.5.1、新增代码行
3.5.2、删除代码行
3.5.3、修改代码行

1、目的
统一规范XCode编辑环境下Objective-C的编码风格和标准
2、适用范围
适用于所有用Objective-C语言开发的项目。
3、编码规范
3.1、文件

1. 项目文件必须使用一个有意义的名字且前缀以PRJ_。例如：XCcode中下拉刷新的项目文件被命名为’PRJ_ PullDownRefresh.xcodeproj’。
2. 公共文件统一命名为’Public.h’。任何文件的命名尽量不要以中文命名。
   3.2、注释
3. 注释可以采用’ /* / ’和’ // ’两种注释符号，涉及到多行注释时，尽量使用
   ’ / */ ’。
4. 对于一行代码的注释可放在前一行及本行上，不允许放在下一行，更不允许在一行语句的中间加入注释。

3.3、编码排版格式

1. 代码的缩进应使用空格（SPACE），不能使用制表符（TAB），并且缩进以2个字符为单位。
2. 中括弧的每一个括弧在源程序中要单独占一行。
   例如
   //不正确用法
   for (int i = 0; i < 10 ; i++)
   {
   }
   //正确用法
   for (int i = 0; i < 10; i++){
   ……
   }
3. 空格的使用
   a) 关键字与其后的表达式之间要有空格，如：
   if (expr)
   或
   for (expr)
   b) 单目操作符不应与它们的操作数分开（如’!’和’^’等）。
   c) 除’ , ’外，其它双目操作符应与它们的操作数用空格隔开。
   例如
   i=i+1; //错误的写法，操作符两端没有空格
   i = i + 1; //正确的写法，
   if(a>b) //错误的写法，逻辑判断符号两端没有空格
   if(a > b) //正确的写法
   d) .h中协议<>前面有一个空格。
   e) .h中成员声明时，类型与变量之间有至少1个空格。号靠近变量，不靠近类型。
   f) @property后留1个空格，（）里面，逗号紧跟前一变量，与后一变量之间留1个空格。（）外面，先留1个空格，再声明属性。
   g) 方法的+，-后面与（）之间留1个空格。
   h) 返回类型与之间留1个空格，方法参数中返回类型与*之间留1个空格。
   i) 在多参数方法中，每个参数后面都有1个空格。
4. 每行只能有一个语句
   例如
   //不正确写法
   NSUInteger objectIndex, stuffCount;
   或
   objectIndex = objectIndex + 10, stuffCount = stuffCount + 20;
   或
   @synthesize MyView, MyLabelView;
   //正确写法
   NSUInteger objectIndex;
   NSUInteger stuffCount;
   或
   objectIndex = objectIndex + 10;
   stuffCount = stuffCount + 20;
   或
   @synthesize MyView;
   @synthesize MyLabelView;
5. 关于空行
   a) .h中的空行
   ○1、文件说明与头文件包含(#import)之间空1行
   ○2、头文件包含(#import)之间，如果需要分类区别，各类别之间空1行。
   ○3、头文件包含(#import)与@class之间空2行。
   ○4、@interface与@class之间空1行。
   ○5、头文件{}里面，空1行开始声明对象成员，如果需要分类区别，各类别之间空1行。
   ○6、头文件{}外，空1行书写属性，如果需要分类区别，各类别之间空1行。
   ○7、属性下面空1行开始写方法，如果需要分类区别，各类别之间空1行。
   ○8、方法完成后，空1行@end。
   ○9、如果需要声明protocol，空2行接着写。通常protocol写在@end后面，但是声明在@interface之前。
   b) .m中的空行
   ○1、文件说明与头文件包含(#import)之间空1行
   ○2、头文件包含(#import)之间，如果需要分类区别，各类别之间空1行。
   ○3、@implementation和@synthesize之间空1行, 如果需要分类区别，各类别之间空1行。
   ○4、@synthesize与方法之间空1行。
   ○5、方法与方法之间空1行。
   C) 方法里面的空行
   ○1、变量声明后需要空1行，如果需要分类区别，各类别之间空1行。
   ○2、条件、循环，选择语句，整个语句结束，需要空1行。
   ○3、各功能快之间空1行。
   ○4、最后一个括弧之前不空行。
   ○5、注释与代码之间不空行。
   ○6、#pragma mark 与方法之间空1行。
   d) 每行代码最多不得操作100个字。设置如下：Xcode => Preferences => TextEditing
   => Page Guide at column /输入 100即可。
   3.4、命名规范
   3.4.1、保留字

宏命名
全大写 单词间用_分隔
例如: #define THIS_IS_AN_MACRO @” THIS_IS_AN_MACRO”

3.4.2、方法

1. 方法的名称应全部使用有意义的单词组成，且以小写字母开头，多单词组合时，后面的单词首字母大写。
   例如：
   -(void)getUserInformation……
2. 设置类变量的内容的方法应使用set作为前缀，读取变量的内容的方法应使用get作为前缀。
   例如：
   -(void)getUserName;
   -(void)setUserName:(NSString *)userName;
3. 方法中的参数：第一个参数名称要从函数名称上携带出来，第二个参数的首字母小写，多个单词组合时，后面单词首字母大写。参数有别名时，参数别名与参数名一致，但参数名前缀以_。参数别名与前一参数保留1个空格。参数无别名时，以有意义的字母命名。
   例如：
   -(void)myFunctionWithSizeA:(CGSize)sizeA sizeB:(CGSize)_sizeB;

私有方法及变量声明
声明位置
在.m文件中最上方

3.4.3、变量

1. 变量必须起有意义的名字，使其他组员可以很容易读懂变量所代表的意义，变量命名可以采用同义的英文命名，可使用几个英文单词，第一个单词首字母小写，其他单词首字母大写。
   例如：
   NSString *usernameString;
2. 对于一些特殊类型的变量，命名时要带上类型，如NSArray 的变量命名为xxxArray，其他的如xxxDictionary，xxxSize等。这样就可以从名称上知道是什么类型的变量。千万不能将NSArray的变量命名为xxxDictionary。
3. 对于要和interface builder关联的的输出口变量，命名时要后缀以特定的控件名。
   例如：
   IBOutlet UILabel *userNameLabel;
4. 私有实例变量前加一个下划线，如_myPrivateVarible。
5. 枚举变量也要有相应的前缀来区分不同的enum变量。比如苹果公司的一个enum。
   例如：
   typedef enum CGPathDrawingMode CGPathDrawingMode;

/* Drawing modes for text. */

enum CGTextDrawingMode
{
kCGTextFill,
kCGTextStroke,
kCGTextFillStroke,
kCGTextInvisible,
kCGTextFillClip,
kCGTextStrokeClip,
kCGTextFillStrokeClip,
kCGTextClip
};
3.4.4、常量

1. 一些常量前加特殊前缀，可以作为不同常量的区分，
   例如：
   UserDefaultsKey的变量前加UDKEY_,
   NotificationNameKey前面加NNKEY_,
   DictionaryKey前面加DICTKEY_,
   3.4.5、类
   驼峰试命名
   每个单词首字母大写
   例如: TableViewController
   前缀要求 :
   框架相关的类: 使用SINO做前缀
   例如:SINOImageView
   项目相关类:使用项目中自定义的前缀,或不适用前缀
   例如：
   HPHomeViewController HomeViewController等。其他类推。
   HP为例如纪博学 BXHomeViewController

后缀要求
ViewController: 使用ViewController作后缀
例如:HomeViewController
View:使用View作后缀
例如AlertView
UITableCell:使用Cell作后缀
例如:NewsCell
Protocol:使用Delegate或者DataSource作为后缀
例如:UITableViewDelegate
所有保存数据的实体以Model结尾。
例如：
UserModel，
所有的类名，接口名(Protocol)均以大写字母开头，多单词组合时，后面的单词首字母大写。类，接口名必须是有意义的。

对method进行分组
使用 #pragma mark – 方式对类的方法进行分组
例如

大括号的写法
对于类的method:左括号另起一行写
例如

对于其他使用场景:左括号跟在第一行后边
例如:

任何需要写大括号的部分,不得省略
错误示例:

其他:根据实际情况决定

3.5、修改规范
3.5.1、新增代码行
新增代码行的前后应有注释行说明。
//修改人，修改时间，修改说明
新增代码行
//修改结束
3.5.2、删除代码行
删除代码向的前后用注释行说明
//修改人，修改时间，修改说明
要删除的代码行(将要删除的语句进行注释)
//修改结束
3.5.3、修改代码行
修改代码行以注释旧代码行后再新增代码行的方式进行。
//修改人，修改时间，修改说明
//修改前代码行开始
//修改前代码行
//修改前代码行结束
//修改后代码行开始
修改后代码行
//修改结束