iOS项目编码规范(三)表达式

表达式

1.IF语句

  • 表达式(if/else/switch/while等)和花括号总是在同一行打开,在新一行中关闭。
  • if语句如果没有跟else,则可以不需要花括号。
if (isOpen) {
    // Do something
} else {
    // Do something else
}


if (isBad) return something;

2.SWITCH语句

花括号在case语句中不是必须的,但是当一个case语句中包含多行代码时,大括号应该加上;
case的值不应该是魔法数字,应通宏定义、常量、枚举等赋予具体意义。

    switch (tag) {
        case alertTag:
            // ...
            break;
        case buttonTag: {
            // ...
            // Muti-line code
            break;
        }
        default:
            // ...
            break;
    }

当switch的对象值是枚举类型时,可以省略'default'语句。

typedef NS_ENUM(NSUInteger, EarnType) {
    EarnTypeChangePic = 1,          //换头像
    EarnTypeChangeNick = 2,          //换昵称
    EarnTypeChangeSchool = 3,        //换学校
};
...

    EarnType type;
    switch (type) {
        case EarnTypeChangePic: {
            // ...
            break;
        }
        case EarnTypeChangeNick: {
            // ...
            break;
        }
        case EarnTypeChangeSchool: {
            // ...
            break;
        }
    }

注意:XCode中有可以快速编写switch语的插件点击这里

注释

由于Objctive-C自我描述性比较强,代码中尽量少注释,让代码能自我描述。不过需要注释的地方,也不能省略,要清楚的解释对应代码含义或作用,杜绝无效注释。
注释也需要时常维护,保证最新。

几类注释

1.普通注释

//注释/*注释*/类型的注释,常用在代码需要解释的地方,或者暂时不使用的代码块。

// 注释

/*
 ...
 大段注释
 ...
 */

一个实例

    // 非当前审核版本显示所有
    if ([reviewVersion compare:currentVersion] != NSOrderedSame) {
        return NO;
    }
    else {
        // reviewVersion=nil
        // reviewVersion 和 currentVersion一样
        // 表示在审核
        return YES;
    }

注意:// 类型的注释,在斜杠后空一格 商讨

2.文档注释

可以用于生成文档的注释。
凡是以 ////**/*!开头的注释块,都算所appledoc注释。

/// 这是单行注释。
 
/** 这也是单行注释 */
 
/*! 同样是单行注释 */
 
/** 这也是单行注释,
 *  第二行会接上第一行。
 */
  • 注释块中,每一行开头的空格和*字符多数情况都会被appledoc忽略。
  • 连续的两行(即没有间隔空行)的注释,将被合并成一个段落,并忽略换行,就像html。
  • 在注释块内,appledoc支持如下语法:Markdown、HTML、HeaderDoc Tags。

注意:写文档注释可以使用XCode中的插件VVDocumenter-Xcode

3.标记注释

用于在项目中作为标记的注释,通常有以下四种:

//TODO: 用于预留接口或方法的标记。

//FIXME:用于标记BUG等需要修复的地方

//???:有疑问的代码,可以用于review

//!!!:自定义说明

例如

if (isGood) {
    //TODO: 做好结果处理
}
else {
    //FIXME: BUG#3321 闪退,不能用0除
    return 8/0;
}

//???: 这是干嘛- -
a=a;

//!!!: 好思路,先标记下,我要写到小本本里学习学习
x = 1;
y = 2;
x = x ^ y;
y = x ^ y;
x = x ^ y;
// x,y交互完成

注意:标记注释可以和一个XCode的插件一起使用 XToDo

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

推荐阅读更多精彩内容

  • Android编码规范 源文件基础 文件名 源文件以其最顶层的类名来命名,大小写敏感,文件扩展名为.java。 文...
    呼呼哥阅读 878评论 0 0
  • 作者:李旺成 时间:2016年4月3日 1. 前言 这份文档参考了 Google Java 编程风格规范和 Goo...
    diygreen阅读 39,658评论 19 224
  • [The Swift Programming Language 中文版]本页包含内容: Swift提供了多种流程控...
    风林山火阅读 529评论 0 0
  • 《番茄工作法》我的实践,最开始去应用市场下各种版本的app试用,到现在哪个app都不再用,如果用app我总是想看看...
    122182c44b49阅读 102评论 0 0
  • 今天讲两个重度文字依赖症患者的故事。当你点开这篇文的时候,如果找到自己的影子,没关系。 1. 前几天看到朋友在半糖...
    十一号井阅读 629评论 0 0