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)表现内容内容类型图片状态。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,056评论 5 474
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,842评论 2 378
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,938评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,296评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,292评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,413评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,824评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,493评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,686评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,502评论 2 318
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,553评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,281评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,820评论 3 305
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,873评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,109评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,699评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,257评论 2 341

推荐阅读更多精彩内容

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