iOS开发规范文档.docxVIP

精品文档 精品文档 PAGE PAGE #欢迎下载 iOS开发规范 命名 本文推荐驼峰法，也是 Objective-C 社区的标准。 驼峰法分小驼峰法和大驼峰法。小驼峰法：除第一个单词之外， 其他单词首字母大写。大驼 峰法相比小驼峰法，大驼峰法把第一个单词的首字母也大写了。 类命名 类名（不包括类别和协议名）应该用大写开头的大驼峰命名法。 类名中应该包含一个或多个名 词来说明这个类（或者类的对象）是做什么的。 在应用级别的代码里，尽量不要使用带前缀的类名。 每个类都有相同的前缀不能提高可读性。 不过如果是编写多个应用间的共享代码，前缀就是可接受并推荐的做法了 （型如 JKPhotoBrowser ）。 示例1: @i nteface ImageBrowseView :UlView @e nd 示例2：（带前缀JK） @i nteface JKPhotoBrowser :UIView @e nd 类别命名 类名 + 标识 + 扩展（UIImageView +HP+Web） 例：如果我们想要创建一个基于 UIImageView的类别用于网络请求图片，我们应该把类别 放到名字是UllmageView+HPWeb.h的文件里。UIImageView为要扩展的类名，HP为专属标 识，Web为扩展的功能。 类别的方法应该都使用一个前缀（型如hp_myCategoryMethodOnAString ）, 以防止 Objective- C代码在单名空间里冲突。如果代码本来就不考虑共享或在不同的地址空间 （address- space)，方法命名规则就没必要恪守了。 类别 HPWe头文件,UllmageView+HPWeb.h 如下： @in terface UllmageView (HPWeb) -(void)hp_setlmageWithURLStri ng:(NSStri ng *)urlStr; @e nd 方法命名 方法使用小驼峰法命名，一个规范的方法读起来应该像一句完整的话，读过之后便知函数 的作用。执行性的方法应该以动词开头，小写字母开头，返回性的方法应该以返回的内容 开头，但之前不要加 get o 示例： -(void)replaceObjectAtl ndex:(NSUI nteger)i ndex withObject:(id)a nObject; (in sta ncetype)arrayWithArray:(NSArray *)array; 如果有参数，函数名应该作为第一个参数的提示信息，若有多个参数，在参数前也应该有 提示信息(一般不必加 and) 一些经典的操作应该使用约定的动词，如 ini tWith,i nsert,remove,replace,add 等等。 变量命名 变量名使用小驼峰法，使变量名尽量可以推测其用途属性具有描述性。别一心想着少打几 个字母，让你的代码可以迅速被理解更加重要。 5.1类成员变量： 成员变量用小驼峰法命名并前缀下划线， Objective-C 2.0，@property和@synthesize 提 供 了遵守命名规范的解决方法 示例： @i nterface ViewC on troller () @property (nonatomic,strong)NSMutableArray *dataArray; @property (nonatomic,strong)UITableView *tableView; @e nd @implementation ViewController @e nd 5.2 一般变量命名 示例： NSMutableArray *ticketsArray = [NSMutableArrayarrayWithCapacity:O]; NSInteger numCompletedConnections =3; 5.3常量命名 kinvalidHandle ,常量(预定义，枚举，局部常量等 )使用小写k kinvalidHandle , kWritePerm 示例： #define kRunAnnotationStartPointTitle @ 起点” typedef NS_ENUI(NSInteger,RunGoalTypeE){ =0, //无目标 =0, //无目标 =1, //以时间为目标 =2, //以距离为目标 =3, //以消耗卡路里为目标 kRun GoalTypeTime kRun GoalTypeDista nee kRu nGoalTypeCalori }; NSString *const kGroupInfoName =@"name"; 图片资源文件命名 先看下新浪微博app图片资源命名方式，下面是部分截图: " common_