iOS 变量、方法命名规范

 1.基础命名

1.1 清晰

- 命名应该清晰,明确,在做到这两点的基础上尽量简洁。

    例如:

    insert:at:

    应该替换成

    `insertObject:atIndex:`

- 不要使用缩写,长点没有关系

    例如:

    setBkgdColor:

    应该替换成

    `setBackgroundColor:`

-  避免歧义

1.2 统一、连贯性

- 与Cocoa的命名保持统一。

- 不同类中,相同作用的方法或者属性用相同的名字。

    例如:NSView, NSCell, NSControl中的` - (NSInteger)tag`

 1.3 前缀

- 不同模块中使用不同的前缀,但是方法和结构体命名不要使用前缀。

 2.方法命名

2.1 基本规则

- 小写字母开头

- 代表动作的以动词开头,不要用‘do,dose’这样的词 

    例如:`- (void)selectTabViewItem:(NSTabViewItem *)tabViewItem;`

- 获取属性的方法,无需在命名中出现‘get’   

    例如:`- (NSSize)cellSize;`

- 使用关键词描述参数,并紧挨在参数之前   

    例如:- (id)taggedView:(int)aTag; 替换成 `- (id)viewWithTag:(NSInteger)aTag;`

- 继承方法时,将新增的参数往后添加   

例如:

 NSView, UIView.中 

- (id)initWithFrame:(CGRect)frameRect;

NSMatrix, a subclass of NSView 中

- (id)initWithFrame:(NSRect)frameRect mode:(int)aMode cellClass:(Class)factoryId numberOfRows:(int)rowsHigh numberOfColumns:(int)colsWide;

- 多个参数间不要用‘and’连接

 2.1 setter、getter 方法

- 名词 

- (NSString *)title;

- (void)setTitle:(NSString *)aTitle;

- 形容词       

- (BOOL)isEditable;

- (void)setEditable:(BOOL)flag;

- 动词 

- (BOOL)showsAlpha;

- (void)setShowsAlpha:(BOOL)flag;

- 动词在前,名词在后

- (BOOL)glyphInfoAccepted;

替换成

- (BOOL)acceptsGlyphInfo;

 2.2 delegate 方法

- 以发送消息的类名开头

 2.3私有方法

- 基本与公有方法规则一致

- 如果继承Cocoa框架类(例如NSView或UIView),并且要绝对确保私有方法的名称与父类中的名称不同,则可以在私有方法中添加自己的前缀,如MT_addObject:

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

推荐阅读更多精彩内容

  • 前言 说是前言,其实也是本文诞生的目的。随着公司业务的不断增加,功能的快速迭代,app的业务线越来越多,代码体积变...
    Yealink阅读 5,254评论 0 13
  • iOS基础命名基础iOS 代码架构规范 通用规则 在命名方法时,请记住以下几条一般准则: 使用小写字母开始名称,并...
    朱允见阅读 1,505评论 0 1
  • 方法可能是编程接口中最常见的元素,因此在命名方法时应特别注意。以下罗列的是针对使用Objective-C语言的iO...
    小生不怕阅读 1,337评论 1 2
  • 约定 在我看来,开发规范像是一条可供参考的标准线。不同开发者可以根据这条标准线来规范自己的开发行为,尤其是在大的项...
    xxzsxxzs阅读 602评论 1 0
  • 前言说是前言,其实也是本文诞生的目的。随着公司业务的不断增加,功能的快速迭代,app的业务线越来越多,代码体积变得...
    Mr_yinwei阅读 639评论 0 0