iOS Introduction to Coding Guidelines for Cocoa(苹果官方代码规范)

苹果官方代码规范

介绍

为了方便开发者开发应用程序,苹果决定各位开发系统框架的大佬们讨论一下,订个规则,使用cocoa framework 编程的iOS开发者们如何优雅的写代码。

一 命名基本原则

1. 基本原则

  • 清晰原则
    简洁,简单明了,其实就是你要干啥,说清楚。
    代码不是给你自己写的,是给后来维护代码的那个Ta写的,或许是你又或许不是你。是你的话,你过半年再回头看看自己写的代码,当时我在想啥?what?恨不得抽自己?忍住...
    比如:插入一个对象,你要插入啥?一个苹果?一个橘子还是香蕉?
    插入到哪里,插在花瓶里?盘子里?还是碗里?
    插入一个对象(xxxType)到数组的index(XXX)位置
基本命名原则-清晰原则.png
  • 不要缩写
    为什么不要缩写?因为有的单词缩写容易混淆,是截取前四位还是每个单词的首字母,都有可能重复,导致意义不明确。


    不要缩写,表达清楚.png
  • 其实不是不让你缩写,有些是缩写是可以的,比如约定俗称的那些。


    约定俗成的缩写.png
  • 避免模棱两可
    如果,别人看到一个接口,有两种以上的解释,那么重写!!!


    避免模棱两可.png
  • 惯例
    约定俗称的一些东西,主要是区分,请意会
    区分多个同一个类的对象的属性使用基本数据类型,
    给NSNumber (数据包装类型)赋值使用对象类型。


    惯例.png
  • No Self Reference
    这个比较晦涩
    NS 为前缀已经是对象类型了,后面还加一个Object,冗余


    No Self Reference-不要重复表达.png
  • 用一个看似是对象类型的名称代表位确实有点不符合常规,不过通知就经常这么做。
    不符合常规.png

    2. 前缀
  • 前缀对由于框架开发挺重要,主要是功能辨识,所有者区分。NS代表 NeXTSTEP
  • 前缀命名规则,两个或者三个字母(通常是公司或者项目名称或者作者单词缩写),需要注意的是不要使用下滑线作为前缀
  • 类名,协议名,常量,或者typedef structures 枚举 均可以使用前缀,但是方法名,结构体的一个字段就不要用了。方法在类定义的时候编译器会分配一个。结构体名已经有了前缀,某一个字段使用完全是多余。
    前缀.png

    排版规范
  • 函数(方法)命名,使用多个单词,驼峰命名法,不要使用标点符号和下划线作为前缀或者方法的一部分
  • 类名前缀 相关联或者功能相似的类使用相同的前缀,


    排版.png
  • 不要使用下划线作为函数名的前缀,因为cocoa framework 系统会在私有方法前加下划线,如果自定义类名和系统某些函数名重复,会出现错误(重载)。成员前缀可以加下划线。

二 函数命名规则

三 属性和数据类型命名规则

四 关于框架

iOS Introduction to Coding Guidelines for Cocoa(苹果官方代码规范)

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