IOS开发编码及命名规范Word版
IOS开发编码及命名规范推荐精选目录1、目的32、适用范围33、编码规范33.1、文件33.2、注释33.3、编码排版格式43.4、命名规范63.4.1、保留字63.4.2、方法73.4.3、变量73.4.4、常量83.4.5、类83.5、修改规范93.5.1、新增代码行93.5.2、删除代码行93.5.3、修改代码行9推荐精选1、目的统一规范XCode编辑环境下Objective-C的编码风格和标准2、适用范围适用于所有用Objective-C语言开发的项目。3、编码规范3.1、文件1) 项目文件都是使用因文命名。2) 公共文件统一命名为 AppConfigc.h。任何文件的命名尽量不要以中文命名。3) 对于文件的目录要按如下结构创建：-图片等资源文件放在Images.xcassets。 -所有的三方库在单独的组(Group)中，如ThirdPartLibrary。 -所有的分类跟封装放在单独的组中，如Common。3.2、注释1) 注释可以采用 /* */ 和 / 两种注释符号，涉及到多行注释时，尽量使用 /* */ 。2) 对于一行代码的注释可放在前一行及本行上，不允许放在下一行，更不允许在一行语句的中间加入注释。3) 单元文件的文件头注释说明应按如下格式： / 文件名/ 工程名/ Created by 创建者 on 日期./ Copyright 2010 xxx有限公司. All rights reserved./ 系统名称： / 功能描述：/ 修改记录：(仅记录功能修改)/ 张三 2012-02-02 创建该单元 / 小明 2010-03-02 增加本地点单功能。推荐精选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中的空行 、文件说明与头文件包含(#import)之间空1行 、头文件包含(#import)之间，如果需要分类区别，各类别之间空1行。 、头文件包含(#import)与class之间空2行。 、interface与class之间空1行。 、头文件里面，空1行开始声明对象成员，如果需要分类区别，各类别之间空1行。 、头文件外，空1行书写属性，如果需要分类区别，各类别之间空1行。 、属性下面空1行开始写方法，如果需要分类区别，各类别之间空1行。 、方法完成后，空1行end。 、如果需要声明protocol，空2行接着写。通常protocol写在end后面，但是声明在interface之前。 b) .m中的空行 、文件说明与头文件包含(#import)之间空1行 、头文件包含(#import)之间，如果需要分类区别，各类别之间空1行。 、implementation和synthesize之间空1行, 如果需要分类区别，各类别之间空1行。 、synthesize与方法之间空1行。 、方法与方法之间空1行。 C) 方法里面的空行 、变量声明后需要空1行，如果需要分类区别，各类别之间空1行。 、条件、循环，选择语句，整个语句结束，需要空1行。 、各功能快之间空1行。 、最后一个括弧之前不空行。 、注释与代码之间不空行。 、#pragma mark 与方法之间空1行。 d) 每行代码最多不得操作100个字。设置如下：Xcode => Preferences => TextEditing => Page Guide at column /输入 100即可。推荐精选3.4、命名规范3.4.1、保留字Objective-c语言的保留字或关键词应全部使用小写字母，除下表中保留字外，private、protected、public、在类型说明中也作为保留字使用。还有nonatomanic,retain,readwrite,readonly等也有特殊的使用场合。_Bool_Complex_Imaginaryautobreakbycopybyrefcasecharconstcontinuedefaultdodoubleelseenumexternfloatforgotoifininlineinoutintlongonewayoutregisterrestrictreturnselfshortsignedsizeofstaticstructsuperswitchtypedefunionunsignedvoidvolatilewhile3.4.2、方法1) 方法的名称应全部使用有意义的单词组成，且以小写字母开头，多单词组合时，后面的单词首字母大写。例如： -(void)getUserInformation2) 设置类变量的内容的方法应使用set作为前缀，读取变量的内容的方法应使用get作为前缀。 例如： -(void)getUserName; -(void)setUserName:(NSString *)userName;3) 方法中的参数：第一个参数名称要从函数名称上携带出来，第二个参数的首字母小写，多个单词组合时，后面单词首字母大写。参数有别名时，参数别名与参数名一致，但参数名前缀以_。参数别名与前一参数保留1个空格。参数无别名时，以有意义的字母命名。 例如： -(void)myFunctionWithSizeA:(CGSize)sizeA sizeB:(CGSize)_sizeB;3.4.3、变量1) 变量必须起有意义的名字，使其他组员可以很容易读懂变量所代表的意义，变量命名可以采用同义的英文命名，可使用几个英文单词，第一个单词首字母小写，其他单词首字母大写。 例如：推荐精选 NSString *username;2) 对于一些特殊类型的变量，命名时要带上类型，如NSArray 的变量命名为xxxArray，其他的如xxxDictionary，xxxSize等。这样就可以从名称上知道是什么类型的变量。千万不能将NSArray的变量命名为xxxDictionary。3) 对于要和interface builder关联的的输出口变量，命名时要后缀以特定的控件名。 例如： IBOutlet UILabel *userNameLabel;4) 对于使用c语言形式声明的变量，一些特定类型可采用一定的简写： 例如： 指针类型：P 结构体类型：Rec 数组类型：Arr Core Graphic：CG 等。 循环控制变量通常使用单一的字符如：i、j、k等。使用有意义的名字，如objectIndex也是可以的。5) 尽量避免使用全局变量，如果必须使用全局变量则必须加前缀 Pub_,同时应在变量名称中体现变量的类型。6) 私有实例变量前加一个下划线，如_myPrivateVarible。7) 枚举变量也要有相应的前缀来区分不同的enum变量。比如苹果公司的一个enum。 例如： typedef enum CGPathDrawingMode CGPathDrawingMode; /* Drawing modes for text. */ enum CGTextDrawingMode kCGTextFill, kCGTextStroke, kCGTextFillStroke, kCGTextInvisible, kCGTextFillClip, kCGTextStrokeClip, kCGTextFillStroke
