美文网首页
iOS项目命名规范

iOS项目命名规范

作者: Melody旭 | 来源:发表于2018-07-24 10:36 被阅读0次

一、文件夹【业务模块文件夹】
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)表现内容内容类型图片状态。

相关文章

  • iOS项目命名规范

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

  • 内部前端规范v1.0

    项目目录结构规范 请查看 项目目录结构规范 HTML 命名规范 class 命名实行 BEM命名方式。关于BEM,...

  • 文档撰写规范

    一、命名规范 1. 文件命名规范 项目命名词(或项目编号)_文件命名词_日期_V版本号.文件后缀 项目_文件描述_...

  • 2019-06-20

    先手围棋项目代码编写标准(iOS) 文件夹命名 采取英文命名(中文解释其含义),遵循驼峰原则,首字母大写的规范 例...

  • 规范文档

    1.命名规范2.注释规范3.代码规范4.目录规范 1.命名规范 通用规范通用规范是在整个项目中,所有的命名都需要遵...

  • 项目命名规范

    “There are only two hard problems in Computer Science: ca...

  • 项目开发规范参考

    现有项目的开发规范文档 目录 命名规则文件命名 HTML规范 CSS规范 JS规范变量申明简写代码性能优化注释规范...

  • 开发规范1

    安卓项目资源命名规范

  • IOS编码规范

    IOS开发规范 公司新项目马上要启动,整理一篇规范,供参考。 命名规范 驼峰法,除第一个单词之外,其他单词首字母大...

  • 2018-08-13

    浅谈iOS编码规范 命名 awakeFromNib不能拿到真实尺寸

网友评论

      本文标题:iOS项目命名规范

      本文链接:https://www.haomeiwen.com/subject/svbjmftx.html