iOS项目的开发命名规范教程

2020-01-21 02:31:23于海丽

前言

遵守规范也是让代码更清晰明了,易读,易用,易维护,可以更好的适应团队开发。自己看着也是赏心悦目,何乐而不为呢。下面话不多说了,来一起看看详细的介绍吧。

一、关于本文档

1、本文档的书写目的

    《iOS项目的命名规范》的书写目的,在于让后续参加到该项目的iOS开发人员通过阅读该文档,了解在当前iOS项目的代码中的命名要求并严格按照本文档执行,以便保证代码的更好阅读与维护。

2、本文档的使用范围

   《iOS项目的命名规范》在iOS项目中被强制要求执行。将本文中的WSF或者wsf替换成代表项目的前缀(请用三个大写字母),即可用于其他iOS项目。

3、本文档的更新负责人

    《iOS项目的命名规范》由本ID和同事共同协商讨论制定,由本ID负责编辑、修改和后续的版本更新。

二、目录结构

ios开发命名规范,ios,命名规范,ios项目命名规范

三、新建【业务模块文件夹】

1、文件夹的名称需要体现该模块的功能概括。

比如:支付系统、订单

2、二级文件夹根据编程设计模式分类命名,需要从下面词语中取词:

ViewModel、Model、View、ViewController、其他

四、新建【子类】

1、类名

(1)遵循大驼峰命名法。

(2)WSF+模块概括名+功能分区名+父类的惯用后缀。比如:WSFOrderListVC

(3)为了整个项目代码的整洁与统一,建议使用List、Detail、Message、TView、Cell、VC、TVC、VM等字样。

(4)模块概括名一定要是统一的、明确的、唯一的代表模块名称。

(5)父类的惯用后缀的意思是:如果要从其他框架继承子类,那么必须遵循其命名惯例。比如,继承UIView的子类名称必须以View结尾。

2、属性名

(1)遵循小驼峰命名法、避免缩写。

(2)后缀体现属性的数据类型。比如:orderPriceLabel、orderLimitsArray。

(3)使用长的、描述性的命名方向。比如settingButton而不是setBtn。

(4)要求NSString *nameString; 而不是NSString* nameString; 或者NSString * nameString;。

3、属性定义

(1)定义属性的参数顺序排序:原子性、读写、内存管理。比如:@property (nonatomic, readwrite, copy) NSString *nameString;

(2)BOOL类型的属性,需要为其getter方法带is前缀。getter方法放在内存管理限定符前面,比如:@property (nonatomic, readonly, getter=isEditable, assign) BOOL editable;

4、实例变量名

(3)下划线开头