代码规范副本 8.docxVIP

一. 命名规范 随着公司无线部门开发人员的增加，团队保持一致的编码规范对项目来说非常重要，保持项目代码的统一性，能大大减少开发成本和维护成本，也方便团队开发人员阅读代码，希望大家在项目中严格按照文档规范执行，在开发中使用不便的地方，欢迎大家及时提出，我们在讨论之后决定是否保留。 二. 命名规范 1. 类命名 (1). 首字母大写，之后每个单词首字母都大写(驼峰命名法) (2). 使用能够反映类功能的名词短语 (3). 文件和类同名 举例：BaseClient、ImageStore 2. 特殊类命名 (1). 如果是视图控制器的子类应添加后缀“ViewController”或者“Controller” (2). 如果是视图的子类应添加后缀“View” (3). 如果是按钮的子类应添加后缀“Button” …… ?举例：SettingsViewController、NavigationView 3. 分类（类别）命名 (1). 与类命名相同，此外需添加要扩展的类名和“+” 举例：NSString+URLEncoding 4. 协议（委托??命名 (1). 与类命名相同，此外需添加“Delegate”后缀 举例：ReplyViewDelegate 5. 方法命名 (1). 首字母小写，之后每个单词首字母都大写 (2).? 方法名使用动词短语 举例：- (void)setPostValue:(int)value 6. 方法参数命名 (1). 首字母小写，之后每个单词首字母都大写 (2). 具有足够的说明性 (3). 不需要添加类型前缀 举例：- (void)sendUserInfo:(NSDictionary *)userInfo 7. 变量命名 (1).?首字母小写，之后每个单词首字母都大写,例如：int number; (2). 具有足够的说明性 (3).?成员变量不需要添加“m_”前缀 (4). 成员变量添加“_”前缀，例如：_address; 8. 常量 (1). 常量（预定义，局部常量等）使用小写k开头的驼峰法 ?举例：kInvalidHandle?,?kWritePerm ?(2). 枚举类型命名首字母大写，之后每个单词首字母都大写，最后加“s” ?(3). 枚举变量使用枚举类型去掉“s”作为前缀，每个单词首字母大写，中间不允许加下划线 举例： typedef enum UIControlEvents{ UIControlEventTouchDown, UIControlEventTouchUpInside }UIControlEvents; 9. 图片命名 (1). 使用英文，首字母大写，之后每个单词首字母都大写 (2). 添加模块名作为前缀，避免冲突 (3).图片应该与类文件一样，按模块分组放置 10. 分组命名 (1). 使用英文，首字母大写，之后每个单词首字母都大写 (2). 每个分组使用模块的名字 (3). 使用的开源库统一放在“Library”分组下 (4). 使用的公共组件统一放在“Common”分组下 (5). 视图控制器及AppDelegate统一放在“Controllers”分组下 三. 书写规范 1. 注释 尽管写起来很痛苦，但注释是使代码可读性的重要方式，也是维护代码便捷性的方式。我们的注释精确到每个接口、类别、协议，每个方法和成员变量。如： (1). 文件都包含文件头，要说明文件名、作者、创建时间、变更记录 (2). 多人协作完成项目时，public接口的每个方法都应该添加关于函数，参数，返回值以及副作用的注释 ?(3). 当if语句的判断条件复杂时，需要用注释说明判断内容 ?(4). 接口类（继承于BaseClient）的头文件每个方法前都应该注明方法的作用 记得注释是写给编写或阅读代码的人，这个可能是别人，也可能是你自己。 2. 方法 (1). 留一个空格在-或+和返回类型之间，但参数列表里的参数之间不要留间隔，每个冒号之前都必须有对该参数的说明词，如： - (void)doSomethingWithString:(NSString *)string number:(int)num (2). 如果参数过多，推荐每个参数各占一行。使用多行的情况下，在参数前加冒号用于对齐，如： - (void)doSomethingWith:(GTMFoo *)theFoo ? ? ??????? ??????????? ???????rect:(NSRect)theRect ?? ? ? ? ?? ?????????????interval:(float)theInterval 3. 方法调用 如果参数过少所有参数应在同一行 [myObject doFooWith:arg1 name:arg2 error:a