ios开发规范文档.docxVIP

ios开发规范文档

@end

3.类别命名

类名+标识+扩展（UIImageView+HP+Web）

例：如果我们想要创建一个基于UIImageView的类别用于网络请求图片，我们应该把类别

放到名字是UIImageView+HPWeb.h的文件里。UIImageView为要扩展的类名，HP为专属标

识，Web为扩展的功能。

类别的方法应该都使用一个前缀(型如hp_myCategoryMethodOnAString),以防止Objective-

C代码在单名空间里冲突。如果代码本来就不考虑共享或在不同的地址空间(address-

space)，方法命名规则就没必要恪守了。

类别HPWeb头文件，UIImageView+HPWeb.h如下：

@interface?UIImageView(HPWeb)

-(void)hp_setImageWithURLString:(NSString?*)urlStr;

@end

4.方法命名?

方法使用小驼峰法命名,一个规范的方法读起来应该像一句完整的话，读过之后便知函数

的作用。执行性的方法应该以动词开头，小写字母开头，返回性的方法应该以返回的内容

开头，但之前不要加get。

示例：

-(void)replaceObjectAtIndex:(NSUInteger)indexwithObject:(id)anObject;

(instancetype)arrayWithArray:(NSArray?*)array;

如果有参数，函数名应该作为第一个参数的提示信息，若有多个参数，在参数前也应该有

提示信息（一般不必加and）

?一些经典的操作应该使用约定的动词，如initWith,insert,remove,replace,add等等。

5.变量命名?

变量名使用小驼峰法,使变量名尽量可以推测其用途属性具有描述性。别一心想着少打几

个字母，让你的代码可以迅速被理解更加重要。

5.1类成员变量：

成员变量用小驼峰法命名并前缀下划线，Objective-C2.0，@property和@synthesize提供

了遵守命名规范的解决方法

示例：

@interface?ViewController?()

@property?(nonatomic,strong)NSMutableArray??*mDataArray;

@property?(nonatomic,strong)UITableView????*mtableView;

@end

@implementation?ViewController

@end

5.2一般变量命名?

?????

示例：

NSMutableArray?*ticketsArray=[NSMutableArrayarrayWithCapacity:0];??

NSInteger?numCompletedConnections=3;

5.3常量命名?

常量(预定义，枚举，局部常量等)使用小写k开头的驼峰法，比如kInvalidHandle,?

kWritePerm?

示例：

#definekRunAnnotationStartPointTitle??@“起点

typedef?NS_ENUM?(NSInteger,RunGoalTypeE){

??kRunGoalTypeNone???=?0,??//无目标

??kRunGoalTypeTime???=?1,??//以时间为目标

??kRunGoalTypeDistance?=?2,??//以距离为目标

??kRunGoalTypeCalori??=?3,??//以消耗卡路里为目标

};

NSString?*const?kGroupInfoName=@name;

6.图片资源文件命名?

先看下新浪微博app图片资源命名方式，下面是部分截图：

这个图片资源命名方式，以功能为组织形式，是一个很好的习惯，有利于查看资源文件。

原则：

1）采用单词全拼，或者大家公认无岐义的缩写(比如：nav，bg，btn等)

2）采用“模块+功能”命名法，模块分为公共模块、私有模块。公共模块主要包括统一的背

景，导航条，标签，公共的按钮背景，公共的默认图等等；私有模块主要根据app的业务

功能模块划分，比如用户中心，消息中心等

备注：建议背景图采用以bg作前缀，按钮背景采用btn作前缀（不作强制要求，项目实际

负责人根据团队特点确定即可）

公共模块命名示例：

导航条背影图片：bg_nav_bar@2x.png

导航返回按钮：bg_nav_back_normal@2x.png，bg_nav_back_selected@