ios之编码规范详细说明

iOS代码规范：

所有代码规范全部遵循苹果sdk的原则，不清楚的请访问苹果SDK文档或下载官方Demo查看。

1、工程部分：

    将项目中每个功能模块对应的源文件放入同一文件夹下，使用虚拟文件夹。

    引用的.a和相关的文件，独立使用文件夹存放，并标明是SDK

2、类：

    命名：首字母大写，其后每个单词首字母大写，类文件的名字必须与类中主要的@interface类名字一致。（例：RootViewController，PersonInfo）

    category和protocol可以放在独立文件中，或放在某个类之前。

3、代码：

    变量：所有变量命名遵循驼峰规则，变量名需保证见名知意，（例：NSString *personName = @"123",BOOL isTrue = YES）

除此之外还需满足以下条件：

    临时变量以小写字母开头，其后每个单词首字母全部大写，尽量不使用数字和下划线。

    全局变量以下划线开头，禁止使用数字，尽量不在中间使用下划线。

    

4、数据类型：

    能使用Objective-C的数据类型，尽量使用Objective-C的数据类型，切忌交叉使用（哪怕你知道那原本就是一个类型）。

5、属性、方法

    所有属性名不能以下划线开头，尽量不使用单词简写。（例：

@property (nonatomic,strong)NSString *orderNumber;

@property (nonatomic,strong)NSMutableDictionary *studentInfo;

）

    方法名必须以小写字母开头，每个参数描述必须明确的描述后面的参数，每个形参必须确切的表示参数的作用，严禁出现  - (id)init:(NSString *)a b:(NSString *)b作此类的方法名。

6、语句、括号

      所有语句必须遵循左对齐原则，括号位置需保持一致。

      换行前注意语句对齐，嵌套语句中换行和括号必须依次缩进。

7、 注释、标记

     每个不够明确的变量和属性之前，必须加上相关注释。

     每个稍微复杂的方法，必须加上对功能的描述。

     执行到关键步骤时，尽量使用语句提示其作用。

     出现关键性的流程选择时，使用注释提示。

     同一个类中出现其他引用，出现独立功能模块时，添加mark。

     任意待优化、未完善、未测试、不确定的代码，需要添加mark。

     

8、宏、静态全局变量

     尽量写在独立的文件中。

     简短的宏命令尽量使用大写，稍长的可以大写开头，其后使用小写，但尽量添加下划线加以区分。

     大量重复使用的数值尽量使用宏，嵌套层数过多、使用频率较高、格式固定无需较大更改的方法尽量使用宏。

     常用设备信息、屏幕尺寸、固定参数尽量使用宏，接口地址、路径、固定参数可使用宏或全局静态变量。