iOS代码命名规范

虽然说代码风格是个人问题,但是一旦团队项目中充斥着各种各样的个性代码的时候,review就变成了一种痛苦,开发人员也会潜意识的不想去看其他人的代码,鉴于此,整理一个通用的规范还是有必要的,还是那句话,代码是写给人看的。

通用准则

  • 除了一些认可的缩写,其他情况都尽量使用全称,下面列出了常用缩写:
    alloc、alt(alternate)、app、calc、dealloc、func、horiz(horizontal)、info、init、int、max、min、msg、nib、pboard(pasteboard)、rect、rep(representation)、temp、vert(vertical);还有一些常用技术名词缩写如XML、URL这样的
  • 注意保持命名的一致性,最好能够和Cocoa Touch框架的命名保持一致,这个可以参考相关的头文件,作用相同的属性、方法最好能使用相同的命名
  • 使用自定义的前缀(类似Foundation框架用的NS)来命名class、protocol、function、constant、typedef structure
  • 方法使用驼峰命名法,但以小写字母开头;特别是不要以下划线开头来命名方法,这种方式是保留给Apple专用的(下划线开头命名instance variable除外)
  • class的命名应该包含一个能够代表它的名词
  • protocol应该根据它所组织起来的行为来命名;如果protocol内组织的方法不和任意class关联的话,那么可以使用ing形式来命名以避免和某个class的名称混淆,如NSLocking这样;如果protocol和某个class比较相关的话,那可以把这个protocol命名成和这个class一样的名字,如NSObject;
  • 头文件的命名以该文件内最主要的class、protocol、category来命名
  • 每个framework都应该有一个头文件,包含framework的所有public的头文件,然后以framework的名字命名

方法的命名

  • 对于对某个对象实施行为的方法,直接以动词+对象的方式命名,如selectTabViewItem这样
  • 方法描述两种不同的动作,可以用and连接,其他情况尽量不要用and,如openFile: withApplication: andDeactivate
  • 属性存取方法的命名,设置统一使用setXXXX,访问一般为xxx或isXXX;只在需要返回多个值的才使用get开头命名的方法,如getLineDash: count: phase
  • delegate方法的命名一般以消息发送方的类名开头(去掉前缀),如tableView: shouldSelectRow;除非只有一个参数,否则发送方的类名后会加一个冒号隔开,比如myView: didOpen对比myViewCloseWindow:;使用did和will表达已经或将要发生的事件,使用should来表达此事件要求接收方进行一些处理
  • 方法命中不要用pointer或ptr,而是让参数类型去表达这个信息,下面是一些常用的组合形式:
    ...action:(SEL)aSelector ...atIndex:(int)index ...title:(NSString *)aString
    ...target:(id)anObject ...length:(int)numBytes ...intValue:(int)anInt
    ...frame:(NSRect)frameRect ...point:(NSPoint)aPoint ...tag:(int)anInt
    ...font:(NSFont *)fontObject ...content:(NSRect)aRect ...alignment:(int)mode
    ...stringValue:(NSString *)aString ...keyEquivalent:(NSString *)charCode
  • 类的私有方法的命名,为了避免和父类发生冲突,建议采用前缀加下划线的组合,形如KK_xxxxx这样的方式来命名

函数的命名

  • 使用类似class这样的前缀,如NSHighlightRect
  • 一般带动词,但如果是返回第一个参数的一个属性,那可以不要这个动词,如float NSHeight(NSRect aRect)
  • 如果使用引用的方式返回值,那么使用Get作动词,如const char* NSGetSizeAndAlignment(unsigned int* sizep, unsigned int* alignp)
  • 如果返回布尔值,那么应该以受影响者开头,如BOOL NSDecimalIsNotANumber(const NSDecimal* decimal)

数据类型的命名

  • 枚举常量、const变量的命名和函数的命名类似
  • 一般情况下不要用#define来定义常量,一组相关的整数常量可以使用enum定义,float常量用const定义
  • 宏命名全部使用大写,另外双下划线开头的宏是编译器定义的
  • 通知的命名方式:[�关联类名]+[Did | Will]+[�唯一名称]+Notification,如NSApplicationDidBecomeActiveNotification
  • 异常的命名:[前缀]+[唯一名称]+Exception,如NSFontUnavailableException(注意,常规的,可预期的情况返回错误值;想访问不存在的数组下标这类才用异常)
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,588评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,456评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,146评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,387评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,481评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,510评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,522评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,296评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,745评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,039评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,202评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,901评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,538评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,165评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,415评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,081评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,085评论 2 352

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,646评论 18 139
  • 转至元数据结尾创建: 董潇伟,最新修改于: 十二月 23, 2016 转至元数据起始第一章:isa和Class一....
    40c0490e5268阅读 1,698评论 0 9
  • iOS编程规范0规范 0.1前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、可靠、可 测试、高效...
    iOS行者阅读 4,451评论 21 35
  • importUIKit classViewController:UITabBarController{ enumD...
    明哥_Young阅读 3,793评论 1 10
  • 这篇文章是建立在第一篇,spring boot住在jpa, swagger2, loggin,第二篇,spring...
    徐磊x阅读 6,883评论 4 20