iOS项目命名规范

一、文件夹【业务模块文件夹】
1、文件夹的名称需要体现该模块的功能概括。
如:main、scan、order、setting、login


图片.png

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


图片.png

二、新建【子类】
1、类名
(1)遵循大驼峰命名法。
(2)TC+模块概括名+功能分区名+父类的惯用后缀。比如:TCHomeViewController
(3)为了整个项目代码的整洁与统一,建议使用List、Detail、Cell等字样。
(4)模块概括名一定要是统一的、明确的、唯一的代表模块名称。
(5)父类的惯用后缀的意思是:如果要从其他框架继承子类,那么必须遵循其命名惯例。比如,继承UIView的子类名称必须以View结尾。


图片.png

三、属性
1、属性名
(1)遵循小驼峰命名法、避免缩写。
(2)后缀体现属性的数据类型。比如:countLabel、rankButton、squareListDatas。
(3)使用长的、描述性的命名方向。比如myClueButton而不是myBtn。
(4)要求NSString nameString; 而不是NSString nameString; 或者NSString * nameString;。

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

四、变量
1、实例变量名
(1)在本函数内,使用下划线开头,在本函数以外使用下划线开头
(2)遵循小驼峰命名法、避免缩写。
(3)后缀体现属性的数据类型。比如:self.squareListDatas、self.allClueLabel。

2、方法名
(1)遵循小驼峰命名法、避免缩写。
(2)不要使用“and”这个词,它不应该用来阐明有多个参数。
(3)直接父类是其他框架:TC开头。

3、全局变量
(1)遵循大驼峰命名法、避免缩写。
.h文件
extern NSString *const TCTokenCheckRequestUserName;
extern NSString *const TCTokenCheckRequestPassword;

.m文件
NSString *const TCTokenCheckRequestUserName = @"userName";
NSString *const TCTokenCheckRequestPassword = @"password";

4、枚举名
(1)遵循大驼峰命名法、避免缩写。
(2)使用OC的枚举方式。
(3)枚举对象名:TC+枚举范围概括名+Type。比如:TCRegisterType
(4)枚举种类名:TC+枚举范围概括名+Type_某种情况名。比如:TCRegisterType_Register。

5、协议名
(1)遵循大驼峰命名法、避免缩写。
(2)代理协议:类名+Delegate。比如:YYBaseRequestManagerCallBackDelegate。
(3)数据源协议:类名+DataSource。比如:YYBaseRequestManagerParamSource。
(4)普通协议:类名+Protocol。比如:YYBaseRequestManagerProtocol。

四、常用工具
(1)统一归放在tclibrary文件夹下。
(2)遵循大驼峰命名法、避免缩写。如TCTimerCountDown、TCShareHandle。


图片.png

五、第三方工具
(1)统一归放在library文件夹下。
(2)遵循大驼峰命名法、避免缩写。如AFNetworking、FMDB。


图片.png

六:图片资源文件组织
1、图片资源文件
(1)使用Images.xcassets管理。
(2)避免出现中文。
(3)表现内容内容类型图片状态。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 前言 说是前言,其实也是本文诞生的目的。随着公司业务的不断增加,功能的快速迭代,app的业务线越来越多,代码体积变...
    梦翔_d674阅读 1,508评论 0 2
  • 项目目录:主目录按功能模块分类,内部目录按业务分类(model,view,viewcontroller); 总结一...
    MeteorCode阅读 1,236评论 1 0
  • Google的Objective-C编码规范 总览 背景知识 Objective-C是一个C语言的扩展语言...
    渣渣程序猿爱次次大餐阅读 1,610评论 0 3
  • Cocoa代码风格指南之命名规范(一) Cocoa代码风格指南之排版规范(二) Cocoa代码风格指南之注释规范(...
    xuyafei86阅读 3,456评论 0 8
  • 推荐文章:禅与 Objective-C 编程艺 前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、...
    WolfTin阅读 2,842评论 0 1