iOS项目命名规则

项目目录:主目录按功能模块分类,内部目录按业务分类(model,view,viewcontroller);

总结一下命名规范:

  • 驼峰命名法; 描述清楚,避免缩写;
  • 主目录文件夹:项目标识 + 模块概括
  • 内部文件夹:项目标识 + 模块概括 + 业务(view,controller,model等)
  • 类名:项目标识 + 模块概括 + 功能概括 + 父类惯用后缀
  • 属性:属性作用+属性类型;
  • 方法名:体现方法作用,参数要写清楚作用;
  • 协议名: 类名 + 协议类型(delegate,datasourc,其他)
  • 常量:类名 + 常量作用
    注意:标识和概括,都是唯一,统一,整洁的;

文件夹命名

  • 主文件夹的名称:体现该模块的功能概括。比如:支付系统、订单;
  • 内部文件夹:项目标识 + 模块概括 + 业务(view,controller,model等);

类名

  • 驼峰命名法
  • 项目标识符 + 模块概括名 + 功能分区名 + 父类的惯用后缀。比如:ELOrderListVC
    注意:
    模块概括名要统一明确唯一,功能分区名要整洁统一,父类惯用后缀用框架得出。

属性名 和 实例变量名(_开头)

  • 驼峰命名法,避免缩写,体现属性的作用。
  • 后缀体现属性的数据类型。比如:orderPriceLabel、orderLimitsArray。

属性定义

  • 定义属性的参数顺序排序:原子性、读写、内存管理。比如:@property (nonatomic, readwrite, copy) NSString *nameString;
  • BOOL类型的属性,需要为其getter方法带is前缀。getter方法放在内存管理限定符前面,比如:@property (nonatomic, readonly, getter=isEditable, assign) BOOL editable;

公有方法名

  • 驼峰命名法、避免缩写。
  • 方法名体现方法作用,参数写清楚;

私有方法名

  • 驼峰命名法、避免缩写。
  • 直接父类是Cocoa框架:sy_开头。
  • 直接父类是其他框架:框架缩写+下划线开头。比如:sd_、mj_。

纯C函数

  • 驼峰命名法、避免缩写。

全局变量

  • 驼峰命名法
  • 项目标识 + 类名+描述

.h文件
extern NSTimeInterval ELPersonModelAnimationDuration;
extern NSString *ELPersonModelErrorMessage;

.m文件
NSTimeInterval ELPersonModelAnimationDuration = 0.3;
NSString *ELPersonModelErrorMessage = @“ErrorMessage”;

枚举名

  • 驼峰命名法、避免缩写。
  • 枚举对象名:项目标识 + 枚举范围概括名 + Type。比如:ELAlipayResultCodeType
  • 枚举种类名:项目标识 + 枚举范围概括名 + Type_某种情况名。比如:ELAlipayResultCodeType_success。

协议名

  • 驼峰命名法、避免缩写。
  • 代理协议:类名+Delegate。比如:ELOrderListChangedDelegate。
  • 数据源协议:类名+DataSource。比如:ELOrderListDataSource。
  • 普通协议:类名+Protocol。比如:ELOrderListVCProtocol。

分类

分类名

  • 驼峰命名法、避免缩写
  • 类名+标识前缀+扩展标识。

第三方库的封装

  • 手动管理:项目标识 + 框架名,避免冲突;如:ELMJRefresh。
  • pod管理:不需要特殊处理。

常量

私有常量

.m文件
static const NSTimeInterval kAnimationDuration = 0.3;
static NSString *const kErrorMessage = @“ErrorMessage”;

公开常量

.h文件
extern const NSTimeInterval ELPersonModelAnimationDuration;
extern NSString *const ELPersonModelErrorMessage;

.m文件
const NSTimeInterval ELPersonModelAnimationDuration = 0.3;
NSString *const ELPersonModelErrorMessage = @“ErrorMessage”;

  • 遵循小驼峰命名法、避免缩写。
  • 文件内常量:k+常量作用描述;类之外可见常量:模块标识+常量作用描述;

通知

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

推荐阅读更多精彩内容