iOS 开发文档规范

iOS 开发文档规范

  • Method 命名

    • 驼峰

    • 类前缀使用三个字符,避开2个字符的NS,UI,CG,CF,CA,WK,MK,CI,NC

    • 一个执行动作以动词开头。
      - (void)invokeWithTarget:(id)target

    • 直接返回内容不需要加get。间接返回内容,才需要加get。比如通过传入指针,func将操作指针改变内存存储的值,多个值返回的时候使用get

    • 如果子类的方法比父类更明确。更有针对性。不应该重写类本身提供的方法,应该添加一个新的方法

  • Accessor命名规范

    • 可以使用will,should,can 明确方法意义,但是不要使用do,does这类无意义的情态动词。
    • delegate 方法除非只有一个参数,否则冒号加到类名后面
  • Initlalize 规范

    • initialize类方法先于其他的方法调用。且initialize方法给我们提供了一个让代码once、lazy的地方。initialize通常被用于设置class的版本号。initialize方法的调用遵循继承规则(所谓继承规则,简单来讲是指:子类方法中可以调用到父类的同名方法,即使没有调用[super xxx])。如果我们没有实现initialize方法,运行时初次调用这个类的时候,系统会沿着继承链(类继承体系),先后给继承链上游中的每个超类发送一条initialize消息,直到某个超类实现了initlialize方法,才会停止向上调用。某个类的initialize方法可能会被调用多次
    • 如果超类的某个初始化方法不适合于子类,子类覆写这个超类的方法,并在其抛出异常。
    • 不要在子类的初始化方法中调用父类的secondary初始化方法。否则容易陷入方法调用死循环
    • 禁止在子类中使用self 访问属性
  • dealloc规范

    • 不要忘记在dealloc方法中移除通知和KVO
    • dealloc应该放在文件的最上面,并且刚好在 @synthesize 和 @dynamic 语句的后面。在任何类中,init 都应该直接放在 dealloc 方法的下面。
    • 在dealloc方法中,禁止将self作为参数传递出去,如果self被retain住,到下一个runloop在释放,会造成多次crash.
      -(void)dealloc{
      [self unsafeMethod:self];
      // 因为当前已经在self这个指针所指向的对象的销毁阶段,销毁self所指向的对象已经在所难免。如果在unsafeMethod:中把self放到了autorelease poll中,那么self会被retain住,计划下个runloop周期在进行销毁。但是dealloc运行结束后,self所指向的对象的内存空间就直接被回收了,但是self这个指针还没有销毁(即没有被置为nil),导致self变成了一个名副其实的野指针。
      // 到了下一个runloop周期,因为self所指向的对象已经被销毁,会因为非法访问而造成crash问题。
      }
  • block使用

    • block使用时必须对block判空
    • 注意block潜在的引用循环
  • 如果想获取window,不要使用view.window获取,请使用[[UIApplication sharedApplication] keyWindow]

  • 在使用到 UIScrollView,UITableView,UICollectionView 的 Class 中,需要在 dealloc 方法里手动的把对应的 delegate, dataSouce 置为 nil。

  • 一些经常被使用的文件建议做好缓存。避免重复的IO操作。建议只有在合适的时候再进行持久化操作。

  • 不要使用可能为nil的对象,对集合进行初始化。初始化之前对象要进行判空处理。否则会出现crash。

  • 禁止在多线程环境下直接访问可变集合对象中的元素。应该先对其进行copy,然后访问不可变集合对象内的元素

  • block中的return的作用域。block中的return代表的是使当前的block返回,而非使当前的整个函数体返回

  • 懒加载的适用场景

    • 一个对象的创建依赖于其他对象。
    • 项目中使用或者不用
    • 伴随着大量的计算或者性能消耗
  • 多线程规范

    • 禁止使用GCD的dispatch_get_current_queue()函数获取当前线程信息。
    • 剪切板的读取必要时候放在异步线程处理。
    • 仅当必须保证顺序的时候采用dispatch_sync,否则容易出现死锁,应避免应用使用dispatch_async。
  • 内存管理规范

    • 除非知道自己做什么,否则不建议将UIView类的对象加入到NSArray、NSDictionary、NSSet中。如有需要可以添加到NSMapTable 和 NSHashTable
  • 延迟调用规范。
    【必须】performSelector:withObject:afterDelay:要在有Runloop的线程里调用,否则调用无法生效。

    说明:异步线程默认是没有runloop的,除非手动创建;而主线程是系统会自动创建Runloop的。所以在异步线程调用是请先确保该线程是有Runloop的。

  • .h尽量不要暴露属性。属性暴露只读的,.h文件中只暴露出一些必要的类、公开的方法、只读属性;私有类、私有方法和私有属性以及成员变量,尽量写在.m文件中

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

推荐阅读更多精彩内容