iOS Objective-C我喜欢的命名

       类前缀(Class Prefix),文件命名、类命名、方法命名等都可能用到。就如OC的命名大部分都是“NS”(NS——NextStep)开头一样。我们的命名也可以带上自己的标识写在名称前面,用以区分项目、开发者、框架等。这里的前缀名为:LY(2位字母比较好看,但推荐使用3个以上字母,因为苹果自身是使用2位字母的,万一苹果发布新框架,然后和你的命名同名了,那就尴尬了……)。

       类后缀(Class Suffix),文件命名、类命名、方法命名等都可能用到。类是根据父类来命名,用来说明这个类是什么类。UIView 后缀添加“View”、UIButton 后缀添加“Button"、UILabel 后缀添加“Label",是ViewController的就要在名字后面加上“ViewController”。

命名要领:

1.清晰性(简明,可读性高,一个名字就能表明自己的身份)

2.一致性(尽可能与Cocoa编程接⼝命名保持一致,不然别人看你的代码就像一门新语言)


一、文件和类命名

      大驼峰命名法,所有单词的第一个字母大写。可加前缀(Prefix),如:LYUser(用户)、LYNetWork(网络)、LYViewController(视图控制器)等。

      举例展示,看项目或个人需要自行Add或Create。

1.公共文件

公共模型:CommonModel。继承于NSObject,通用设置和方法都可以放在该类,不需要加前缀(Prefix)方便所有项目使用。

公共视图控制器:CommonViewController。继承于UIViewController,通用设置和方法都可以放在该类,不需要加前缀(Prefix)方便所有项目使用。

注:Common(普通的、公共的、共有的),在ThinkPHP里面的意思也是差不多的。也可以使用Base代替。

2.管理文件

日历管理:CalendarManager。继承于NSObject,所有日期(Date)时间(Time)配置、时间格式转换、时间计算查询等操作方法都可以写在这里。不需要加前缀(Prefix)方便所有项目使用。

颜色管理:ColorManager。继承于NSObject,所有颜色配置、颜色格式转换、夜间模式设置方法都可以写在这里。不需要加前缀(Prefix)方便所有项目使用。

注:Manager(处理者、管理者),也可以使用Helper代替,OC里面面向对象管理。

3.其他文件

用户文件:LYUser。定义项目角色的属性,设置用户的注册、登录、忘记密码、修改密码、资料获取和资料编辑等。

单例文件:LYSingleton。定义项目临时存储属性,设置单例属性,方便临时保存数据。

注:OC里面面向对象的一个对象,这种对象在项目中是一个重要角色,所以直接命名。

二、宏定义命名

      全局宏定义使用大写开头、局部宏定义小写开头并区分类型。全局宏定义,放在 config.h 文件或者Macros.h文件;局部宏定义放在需要用的文件的.h文件顶端。

1.全局宏定义

1.1分类名全部大写,比如:COLOR(颜色)、URL(地址)、FONT(字体类型)、TEXT(文本)、STRING(字符串);

1.2分类与分类之间用下划线间隔;

1.3分类名分级由大到小。

例如:

2.局部宏定义

匈牙利命名法,以k开头,后接大驼峰命名法。

例如:

注:k-恒定值 用在key键、恒定字符串That's a general programming notation not specific to Objective-C (i.e. Hungarian Notation) and the "k" stands for "constant".

三、常量命名

匈牙利命名法,以k开头,后接大驼峰命名法;或者以k开头,后接大驼峰命名法,中间加下划线“_”间隔。

例如:

四、变量命名

小驼峰命名法。除第一个单词外,其它单词首字母大写。要突出属性特性,必要时要加上类后缀(Class Suffix)。

1.全局变量

关键字:@property (nonatomic, strong),外部可以访问。

例如:

2.局部变量

在.h或.m内声明,并以下划线“_”开头。

例如:

五、枚举命名

大驼峰命名法,可加前缀(Prefix)。关键字:typedef NS_ENUM

例如:

六、别名命名

大驼峰命名法,可加前缀(Prefix)。关键字:typedef

例如:

七、类别命名

大驼峰命名法,可加前缀(Prefix)。关键字:Category

例如:

八、方法命名

小驼峰命名法。setting方法要写上set,getting方法可以省略get,符合Cocoa编程接⼝命名规则。传入参数统一小驼峰命名。方法名称要能简明表达方法的作用,方便阅读调用。

九、常用命名

助手:Helper

类库:Classes / Libraries

管理:Manager

资源:Resources

工具:Tool / Utils

账号:Account

密码:Password

头像:Avatar

首页面、我的页面、设置页面:Home、Me、Settings

关键字:Keywords

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

推荐阅读更多精彩内容