ios开发规范文档样稿.docx

命名
命名规则对于维护代码来说是很关键,。Objective-C方法名往往很长，不过这也有好处，让很多注释变得毫无意义。
本文推荐驼峰法，也是Objective-C小区标准。 
驼峰法分小驼峰法和大驼峰法。小驼峰法：除第一个单词之外，其它单词首字母大写。大驼峰法相比小驼峰法，大驼峰法把第一个单词首字母也大写了。

清楚
又清楚又简练是最好了，但简练不如清楚关键。总讲不要使用单词简写，除了很常见简写以外，尽可能使用单词全称。API名称不要有歧义，一看你API就知道是以什么方法做了什么事情，不要让人有疑问
一致性
做某个事情代码通常全部叫这个名字，比如tag、setStringValue，那么你也这么叫。你在不确定怎么起名字时候，能够参考部分常见名字：Method Arguments
2. 类命名
类名(不包含类别和协议名)应该用大写开头大驼峰命名法。类名中应该包含一个或多个名词来说明这个类（或类对象）是做什么。
在应用等级代码里，尽可能不要使用带前缀类名。每个类全部有相同前缀不能提升可读性。不过假如是编写多个应用间共享代码，前缀就是可接收并推荐做法了(型如 MBAPhotoBrowser )。
示例1：
***@interface ImageBrowseView :UIView
***@end
示例2：（带前缀MBA）
***@interface MBAPhotoBrowser :UIView
***@end
3. 类别命名
类名+标识+扩展（UIImageView +HP+Web）
例：假如我们想要创建一个基于UIImageView 类别用于网络请求图片，我们应该把类别
放到名字是UIImageView+。UIImageView为要扩展类名，HP为专属标
识，Web为扩展功效。
类别方法应该全部使用一个前缀(型如hp_myCategoryMethodOnAString ),以预防Objective-
C代码在单名空间里冲突。假如代码原来就不考虑共享或在不一样地址空间(address-
space)，方法命名规则就没必需恪守了。
类别HPWeb头文件，UIImageView+：
***@interface UIImageView (HPWeb)
- (void)hp_setImageWithURLString:(NSString *)urlStr;
***@end
4. 方法命名 
方法使用小驼峰法命名, 一个规范方法读起来应该像一句完整话，读过以后便知函数
作用。实施性方法应该以动词开头，小写字母开头，返回性方法应该以返回内容
开头，但之前不要加get。
示例：
- (void)replaceObjectAtIndex:(NSUInteger)index withObject:(id)anObject;
(instancetype)arrayWithArray:(NSArray *)array;
假如有参数，函数名应该作为第一个参数提醒信息，若有多个参数，在参数前也应该有
提醒信息（通常无须加and）
 部分经典操作应该使用约定动词，如initWith,insert,remove,replace,add等等。
5. 变量命名 
变量名使用小驼峰法, 使变量名尽可能能够推测其用途属性含有描述性。别一心想着少打几
个字母，让你代码能够快速被了解愈加关键。
类组员变量：
组员变量用小驼峰法命名并前缀下划线，Objective-C ，***@property 和 ***@synthesize 提供
了遵守命名规范处理方法
示例：
***@interface ViewController ()
***@property (nonatomic,strong)NSMutableArray    *mDataArray;
***@property (nonatomic,strong)UITableView       *mtableView;
***@end
***@implementation ViewController
***@end
通常变量命名 
        
示例：
NSMutableArray  *ticketsArray = [NSMutableArrayarrayWithCapacity:0];    
NSInteger numCompletedConnections =3;
常量命名 
常量(预定义，枚举，局部常量等)使用小写k开头驼峰法，比如kInvalidHandle , 
kWritePerm 
示例