【objc-zen-book】5.美化代码 & 代码组织

这个小系列是从 "Zen and the Art of the Objective-C Craftsmanship"中 进行的摘抄,共分成6篇,大部分是讲代码风格及美化,偶尔看看也不错。


美化代码

  1. 缩进使用 4 个空格,永远不要使用 tab。(因为不同的文字处理程序对tab可能有不同的处理,在你这里是4个空格,在别的地方可能就不是了。)

  2. if/else/switch/while 的大括号总是在同一行开始,在新起一行结束。

    // 推荐
    if (user.isHappy) {
        //Do something
    }
    else {
        //Do something else
    }
    
    // 不推荐
    if (user.isHappy)
    {
      //Do something
    } else {
      //Do something else
    }
    
  3. 方法之间应该要有一个空行来帮助代码看起来清晰且有组织。 方法内的空格应该用来分离功能,但是通常不同的功能应该用新的方法来定义。

  4. 应该总是让冒号对齐。有一些方法签名可能超过三个冒号,用冒号对齐可以让代码更具有可读性。即使有代码块存在,也应该用冒号对齐方法。

    // 推荐
    [UIView animateWithDuration:1.0
                     animations:^{
                         // something
                     }
                     completion:^(BOOL finished) {
                         // something
                     }];
    
    // 不推荐
    [UIView animateWithDuration:1.0 animations:^{
        // something 
    } completion:^(BOOL finished) {
        // something
    }];
    
  5. 关于换行

    // 推荐
    self.productsRequest = [[SKProductsRequest alloc] 
      initWithProductIdentifiers:productIdentifiers]; // 一行很长的代码在第二行以一个间隔(2个空格)延续
    
    // 不推荐
    self.productsRequest = [[SKProductsRequest alloc] initWithProductIdentifiers:productIdentifiers];
    
  6. 关于括号

    1. 控制语句 (if-else, for, switch) 使用 Egyptian风格括号(又称 K&R 风格,代码段括号的开始位于一行的末尾,而不是另外起一行的风格。)
    2. 类的实现 和 方法的实现 不使用 Egyptian风格括号。

代码组织

  1. 利用代码块

    代码块如果在闭合的圆括号内的话,会返回最后语句的值。

    NSURL *url = ({
        NSString *urlString = [NSString stringWithFormat:@"%@/%@", baseURLString, endpoint];
        [NSURL URLWithString:urlString];
    });
    
  2. 利用#pragma mark - 来分离。

    - (void)dealloc { /* ... */ }
    - (instancetype)init { /* ... */ }
    
    #pragma mark - View Lifecycle (View 的生命周期)
    
    - (void)viewDidLoad { /* ... */ }
    - (void)viewWillAppear:(BOOL)animated { /* ... */ }
    - (void)didReceiveMemoryWarning { /* ... */ }
    
    #pragma mark - Custom Accessors (自定义访问器)
    
    - (void)setCustomProperty:(id)value { /* ... */ }
    - (id)customProperty { /* ... */ }
    
    #pragma mark - IBActions  
    
    - (IBAction)submitData:(id)sender { /* ... */ }
    
    #pragma mark - Public 
    
    - (void)publicMethod { /* ... */ }
    
    #pragma mark - Private
    
    - (void)zoc_privateMethod { /* ... */ }
    
    #pragma mark - UITableViewDataSource
    
    - (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath { /* ... */ }
    
    #pragma mark - ZOCSuperclass
    
    // ... 重载来自 ZOCSuperclass 的方法
    
    #pragma mark - NSObject
    
    - (NSString *)description { /* ... */ }
    
  3. 忽略没用使用变量的编译警告

    - (NSInteger)giveMeFive
    {
        NSString *foo;
        #pragma unused (foo)  // 注意,要标记到变量之后
    
        return 5;
    }
    
  4. 明确编译器警告和错误

    - (NSInteger)divide:(NSInteger)dividend by:(NSInteger)divisor
    {
        #error Whoa, buddy, you need to check for zero here!
        return (dividend / divisor);
    }
    
    - (float)divide:(float)dividend by:(float)divisor
    {
        #warning Dude, don't compare floating point numbers like this!
        if (divisor != 0.0) {
            return (dividend / divisor);
        }
        else {
            return NAN;
        }
    }
    
  5. 字符串文档

    短文档适用于单行的文件,包括注释斜杠。它适合简短的函数,特别是(但不仅仅是)非 public 的 API。

    // Return a user-readable form of a Frobnozz, html-escaped.
    

    如果描述超过一行,应改用长字符串文档:

    以/**开始

    换行写一句总结的话,以?或者!或者.结尾。

    空一行

    在与第一行对齐的位置开始写剩下的注释

    最后用*/结束。

    /**
     This comment serves to demonstrate the format of a docstring.
    
     Note that the summary line is always at most one line long, and
     after the opening block comment, and each line of text is preceded
     by a single space.
    */
    

    一个函数必须有一个字符串文档,除非它符合下面的所有条件:

    非公开

    很短

    显而易见

    字符串文档应该描述函数的调用符号和语义,而不是它如何实现。

  6. 关于注释

    头文档

    一个类的文档应该只在 .h 文件里用 Doxygen/AppleDoc 的语法书写。 方法和属性都应该提供文档。

    /**
     *  Designated initializer.
     *
     *  @param  store  The store for CRUD operations.
     *  @param  searchService The search service used to query the store.
     *
     *  @return A ZOCCRUDOperationsStore object.
     */
    - (instancetype)initWithOperationsStore:(id<ZOCGenericStoreProtocol>)store
                              searchService:(id<ZOCGenericSearchServiceProtocol>)searchService;
    
  7. 也就是说,当你定义一个类并且对外提供接口,那么需要在头文件中对这个类进行说明,并且对每一个属性/方法都要有明确的说明(使用上面提到的方式,用Doxygen/AppleDoc语法来书写注释。包括方法的参数,返回值等。)。而在实现文件中,如果一个方法/属性是简单,显而易见并且非公开的,那么可以不写注释,前提是保证让人一看就懂。


所有文章
【objc-zen-book】1.条件语句&Case语句的注意
【objc-zen-book】2.命名
【objc-zen-book】3.类
【objc-zen-book】4.Category & NSNotification
【objc-zen-book】5.美化代码 & 代码组织
【objc-zen-book】6.Block & self的循环引用

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

推荐阅读更多精彩内容

  • 转至元数据结尾创建: 董潇伟,最新修改于: 十二月 23, 2016 转至元数据起始第一章:isa和Class一....
    40c0490e5268阅读 1,625评论 0 9
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,050评论 18 139
  • 最近在整理代码,所以将以前积累的一些代码规范方面的知识分享出来,希望能对大家编码时有所帮助。一个好的代码风格的重要...
    小小土豆dev阅读 1,849评论 3 19
  • 概述在iOS开发中UITableView可以说是使用最广泛的控件,我们平时使用的软件中到处都可以看到它的影子,类似...
    liudhkk阅读 8,823评论 3 38
  • No.57 人是一种短视的动物,通常一次教训还不足以使其看清某种用途的损益,要经事实的反复教训才会明白。简言之“切...
    进阶的石先生阅读 173评论 0 0