ios之编码规范具体说明

Posted 2020-09-14 jzssuanfa

ios代码规范：

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

1、project部分：

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

    引用的.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、宏、静态全局变量

     尽量写在独立的文件里。

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

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

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