Objective-C编码注意事项

命名规范,避免重名

  • 加前缀避免命名冲突
    • 所选前缀应与公司、应用程序或二者皆有关联,并在所有代码中均使用这一前缀
    • 所选前缀应为三个字母以上(包含)
    • 若自己所开发的程序中用到了第三方库,需为其名称增加前缀
    • 为私有方法加前缀,与公共方法区分开
    • 不要用"_"一个下划线的方法做前缀
    • 第三方类添加分类,为其名称以及方法名加上专用前缀
  • 命名方式
    • 遵循驼峰式大小写命名法,方法、变量小写字母开头,其他单词首字母大写,类名首字母大写,且通常加上前缀。
    • 方法名从左向右读起来通俗易懂(英文),不要使用缩略后的名称
    • 要与代码框架整体风格相符合

头文件引用

  • 在类的头文件中尽量少引入其他头文件

  • 引用Objective-C或者Objective-C++的头文件时,使用#import

  • 引用的是一个C或者C++的头文件时,使用#include,这时必须保证被引用的文件提供了保护域(#define guard),以保证代码在不同平台间共享时不出现问题。

  • 引用与框架同名的头文件,而不是其它子模块的头文件。

  • 尽量避免在pch中引用头文件,引用过多造成编译速度变慢。

代码格式化

  • 类方法声明在方法类型与返回类型之间要有空格

  • 条件判断的括号内侧不应有空格

  • 关系运算符两边要有空格

  • 方法内部尽可能早的返回错误
  • 使用可读性更好的语法糖来构造NSArray,NSDictionary等数据结构,避免使用冗长的alloc,init方法

  • 尽量使用不可变对象

nil检查,传入参数做保护处理

  • NSMutableDictionary->key&NSMutableArray不能插入nil

  • NSAttributedString

  • NSJSONSerialization,JSONObjectWithData

  • @{key:value},value不能为nil

  • strtoul([colorString UTF8String], colorString不能为nil

  • CFRelease传入值不能为nil

  • 不要使用诸如 nil == Object 或者 Object == nil 的形式来判断

注意事项

  • 使用length,对字符串类型做检查
  • 在if else 判断中,必须加上{ },无论是判断语句是一句 还是多句。判断应该先筛除不符合的逻辑,然后处理重点逻辑
  • 在init和dealloc中避免使用存取方法

注释

  • 方法注释参数的意义,返回值,功能及可能的副作用。

  • 协议,委托的注释要明确说明其被触发的条件

  • 定义在头文件里的接口方法,属性必须要有注释。

  • 如果在注释中要引用参数名或者方法函数名,可使用“||”将参数或方法括起来以避免歧义。

参考资料:《Effective Objective-C 2.0》
后续更新

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

推荐阅读更多精彩内容