代码规范

1. 命名规则:

a) 类名首字母大写,方法首字母小写,方法中的参数首字母小写。所有命名采用驼峰命名法。
b) 所有命名不允许与系统参数命名一致,例如:

UITableView *tableView。

c) 宏定义命名大写字母,能直观表达出宏定义的含义,单词之间以下划线隔开,例如:

#define DISPATCH_SOURCE_TYPE_TIMER。

d) 命名禁止使用单字母,应该尽量能表达变量含义,而且要有注释解释说明。
e) 私有变量的声明命名。
f) 全局变量的声明命名。
g) 方法的声明命名。
h) 资源命名规则:见第5条。

2. 注释

a) 所有的需要注释的地方:类文件的解释,变量或参数的解释,方法的解释,宏定义的解释,代码逻辑的解释等。
b) #pragma mark - 或者 // MARK: 标记分类。
c) 所有注释尽量采用代码块注释:/** 这样的注释 */。
d) 解释类注释必须采用代码块注释。例如:方法名解释,版权解释,类解释,变量或参数解释等。
e) 对OC:私有变量或方法的声明一律写进实现文件.m中。
f) 推荐使用插件:VVDocumenter-Xcode

3. 对齐、换行与缩进

a) {}:{ 跟在外部代码后面的,内部代码与上 { 之间保持一个换行。{ 与外部代码另起一行的,内部代码不必另起一行。{}
b) 代码块与代码块之间,必须保持换行(空一行或两行),不允许出现从上到下一堆。
c) @关键字与代码保持空一行。
d) 所有代码必须保持对齐。

4. 空格

a) 运算符前后必须加空格。
b) 多参数,每个参数的逗号后必须加空格,例如:time(x, y)。
c) 星号 * 与类型必须有一个空格,与变量之间无空格,例如:NSString *str。

5. 资源命名规则

资源命名全部使用小写字母,单词之间以下划线分隔,应能充分表达意思,以前缀区分资源,防止重名,以后缀区分资源类型(比如图片正常状态,高亮状态等)。

6. 编码

保证每一行代码都要简洁、明了,对比如下:
不提倡的非规范代码:
    unitYuXi.navigationItem.title = [[[skListArray objectAtIndex:indexPath.section] objectForKey:@"units"] objectForKey:@"title"];
提倡的规范代码:
    NSDictionary *msgDict = [skListArray objectAtIndex:indexPath.section];
    NSDictionary *unitsDict = [msgDict objectForKey:@"units"];
    unitYuXi.navigationItem.title = [unitsDict objectForKey:@"title"];
模块化开发

代码尽可能功能模块化,所有代码文件保证1000行代码之内。
封装:把模块化的功能全部封装出来,封装时要注意,只处理功能效果,不负责业务逻辑处理。

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

推荐阅读更多精彩内容

  • iOS编程规范0规范 0.1前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、可靠、可 测试、高效...
    iOS行者阅读 4,418评论 21 35
  • 推荐文章:禅与 Objective-C 编程艺 前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、...
    WolfTin阅读 2,736评论 0 1
  • [TOC] 前言 这份文档是Google Java编程风格规范的完整定义。当且仅当一个Java源文件符合此文档中的...
    marine8888阅读 1,937评论 0 1
  • 示例 下面是一个示例头文件,演示了@interface声明的正确注释和间隔 一个示例源文件,演示了一个接口的@ i...
    我是Damo阅读 1,971评论 2 5
  • 最近临近学期末,朋友圈里开始哀嚎遍野或者开始立flag了,比如“不求高分能拿钱,只求60过个年”,平常的学科还好办...
    W王追风阅读 1,086评论 13 38