美文网首页iOS 技术分享
iOS -  Objective-C代码规范

iOS -  Objective-C代码规范

作者: Joh蜗牛 | 来源:发表于2022-09-13 11:23 被阅读0次

    一、排版格式

    1.缩进

    代码的缩进应使用空格(Space),不要使用制表符(Tab),且缩进2个字符为单位。
    可在Xcode > Preferences > Text Editing中进行设置。

    2.空格

    1)关键字与其后的表达式之间要有空格;
    2)单目操作符不应与他们的操作数分开;

    示例:
    a=a+1;          //错误写法,操作符两端无空格
    a = a + 1;      //正确写法
    if(a>b)           //错误写法,逻辑判断符号两端无空格
    if(a > b)        //正确写法
    

    3).h中协议<>前面有一个空格。
    4).h中成员声明时,类型与变量之间有至少一个空格。****号靠近变量,不靠近类型。
    5)@property后留一个空格。
    ()里面:逗号紧跟前一个变量,与后一个变量之间留一个空格;
    ()外面:先留一个空格,再声明变量。
    6)方法的+、-后面与()之间留一个空格。
    7)返回类型与**之间留一个空格,方法参数中返回类型与****之间留一个空格。

    如:
    @property (nonatomic, strong) NSString *imgName;
    
    3.空行
    1. h中的空行
      1)文件说明与头文件包含(#import)之间空一行
      2)头文件包含(#import)之间,如果需要分类区别,各类别之间空一行。
      3)头文件包含(#import)与@class之间空两行。
      4)@interface与@class之间空一行。
      5)头文件{ }里面,空一行开始声明对象成员,如果需要分类区别,各类别之间空一行。
      6)头文件{ }外,空一行书写属性,如果需要分类区别,各类别之间空一行。
      7)属性下面空一行开始写方法,如果需要分类区别,各类别之间空一行。
      8)方法完成后,空一行@end。
      9)如果需要声明protocol,空两行接着写。通常protocol写在@end后面,但是声明在@interface之前。

    2. m中的空行
      1)文件说明与头文件包含(#import)之间空一行
      2) 头文件包含(#import)之间,如果需要分类区别,各类别之间空一行。
      3) @implementation和@synthesize之间空一行,如果需要分类区别,各类别之间空一行。
      4) @synthesize与方法之间空一行。
      5) 方法与方法之间空一行。

    3. 方法里面的空行
      1)变量声明后需要空一行,如果需要分类区别,各类别之间空一行。
      2)条件、循环和选择语句,整个语句结束,需要空一行。
      3)各功能块之间空一行。
      4)最后一个括弧之前不空行。
      5)注释与代码之间不空行。
      6) #pragma mark与方法之间空一行。

    4. 每行代码最多不得超过100个字。
      设置如下:
      Xcode => Preferences =>TextEditing => Page Guide at column/输入100即可设置成功。

    二、命名规范

    基本原则

    1.清晰性
    1. 命名应该尽可能的清晰和简洁,但在Objective-C中,清晰比简洁更重要。由于Xcode强大的自动补全功能,我们不必担心名称过长的问题。
    示例:
    
    //清晰
    insertObject:atIndex:
    removeObjectAtIndex:
    
    //不清晰
    insert:at://insert的对象类型和at的位置属性没有说明
    remove://remove的对象类型没有说明,参数的作用没有说明
    
    1. 不要使用单词的简写,要拼写出完整的单词:
    示例:
    
    //清晰
    destinationSelection
    setBackgroundColor:
    
    //不清晰,不要使用简写
    destSel
    setBkgdColor:
    
    1. 有部分单词简写在Objective-C编码过程中非常常用,以至于成为了一种规范,这些简写可以在代码中直接使用。
    如:
    
    alloc   == Allocate                 max    == Maximum
    alt     == Alternate                min    == Minimum
    app     == Application              msg    == Message
    calc    == Calculate                nib    == Interface Builder archive
    dealloc == Deallocate               pboard == Pasteboard
    func    == Function                 rect   == Rectangle
    horiz   == Horizontal               Rep    == Representation (used in class name such as NSBitmapImageRep).
    info    == Information              temp   == Temporary
    init    == Initialize               vert   == Vertical
    int     == Integer
    
    2.一致性

    整个工程的命名风格要保持一致性,最好和苹果SDK的代码保持统一。
    不同类中完成相似功能的方法应该叫一样的名字,比如我们总是用count来返回集合的个数,不能在A类中使用count而在B类中使用getNumber。

    命名示例

    1.Bundle ID命名

    Bundle ID 采用反域名命名规则,全部使用小写字母,一级包名为com,二级包名根据应用进行命名。

    2.类命名
    1. 采取驼峰命名法规则,即首字母必须大写。
      如果为词组,则每个单词的首字母必须大写,类名只能使用名词或名词词组,力求类名简单,不允许出现冗余的单词。
    2. 以文件类型结尾:
      1)继承自UIView的类以View结尾;
      2)继承自ViewController的类以ViewController结尾;
      3)保存数据的实例以Model结尾;
    3.协议命名

    协议名称应该清晰地表示它所执行的行为,而且要和类名区别开来,所以通常使用ing词尾来命名一个协议,比如NSCopying,NSLocking。

    有些协议本身包含了很多不相关的功能,主要用来为某一特定类服务,这时候可以直接用类名来命名这个协议,比如NSObject协议,它包含了id对象在生存周期内的一系列方法。

    4.头文件命名

    源码的头文件名应该清晰地暗示它的功能和包含的内容:

    1. 如果头文件内只定义了单个类或者协议,直接用类名或者协议名来命名头文件,比如NSLocale.h定义了NSLocale类。
    2. 如果头文件内定义了一系列的类、协议、类别,使用其中最主要的类名来命名头文件,比如NSString.h定义了NSString和NSMutableString。
    3. 每一个Framework都应该有一个和框架同名的头文件,包含了框架中所有公共类头文件的引用,比如Foundation.h
    4. Framework中有时候会实现在别的框架中类的类别扩展,这样的文件通常使用被扩展的框架名+Additions的方式来命名,比如NSBundleAdditions.h。
    5.变量命名

    第一个单词首字母必须小写,往后的单词需要符合驼峰命名法,即第一个字母大写,变量名尽可能使用名词或名词词组,要求简单易懂,不允许出现无意义的单词。

    6.常量命名

    如果要定义一组相关的常量,尽量使用枚举类型(enumerations),枚举类型的命名规则和函数的命名规则相同。
    使用const定义浮点型或者单个的整数型常量,如果要定义一组相关的整数常量,应该优先使用枚举。常量的命名规范和函数相同:

    const float NSLightGray;
    

    不要使用#define宏来定义常量,如果是整型常量,尽量使用枚举,浮点型常量,使用const定义。#define通常用来给编译器决定是否编译某块代码,比如常用的:

    #ifdef DEBUG
    
    7.属性及变量命名
    1. 属性和对象的存取方法相关联,属性的第一个字母小写,后续单词首字母大写,不必添加前缀。属性按功能命名成名词或者动词:
    //名词属性
    @property (strong) NSString *title;
    //动词属性
    @property (assign) BOOL showsAlpha;
    
    1. 属性也可以命名成形容词,这时候通常会指定一个带有is前缀的get方法来提高可读性:
    @property (assign, getter=isEditable) BOOL editable;
    
    1. 命名实例变量,在变量名前加上前缀(有些有历史的代码会将放在后面),其它和命名属性一样:
    @implementation MyClass {
        BOOL _showsTitle;
    }
    
    1. 一般来说,类需要对使用者隐藏数据存储的细节,所以不要将实例方法定义成公共可访问的接口,可以使用@private,@protected前缀。

    按苹果的说法,不建议在除了init和dealloc方法以外的地方直接访问实例变量,但很多人认为直接访问会让代码更加清晰可读,只在需要计算或者执行操作的时候才使用存取方法访问,所以这里不作要求。

    8.通知命名

    通知常用于在模块间传递消息,所以通知要尽可能地表示出发生的事件,通知的命名范式是:

    [触发通知的类名] + [Did | Will] + [动作] + Notification
    

    示例:

    NSApplicationDidBecomeActiveNotification
    NSWindowDidMiniaturizeNotification
    NSTextViewDidChangeSelectionNotification
    NSColorPanelColorDidChangeNotification
    
    9.代理命名

    当特定的事件发生时,对象会触发它注册的委托方法。委托是Objective-C中常用的传递消息的方式。委托有它固定的命名范式。

    一个委托方法的第一个参数是触发它的对象,第一个关键词是触发对象的类名,除非委托方法只有一个名为sender的参数:

    //第一个关键词为触发委托的类名
    - (BOOL)tableView:(NSTableView *)tableView shouldSelectRow:(int)row;
    - (BOOL)application:(NSApplication *)sender openFile:(NSString *)filename;
    
    //当只有一个"sender"参数时可以省略类名
    - (BOOL)applicationOpenUntitledFile:(NSApplication *)sender;
    

    根据委托方法触发的时机和目的,使用should,will,did等关键词

    - (void)browserDidScroll:(NSBrowser *)sender;
    
    - (NSUndoManager *)windowWillReturnUndoManager:(NSWindow *)window;、
    
    - (BOOL)windowShouldClose:(id)sender;
    
    10.方法命名

    Objective-C的方法名通常都比较长,这是为了让程序有更好地可读性,按苹果的说法“好的方法名应当可以以一个句子的形式朗读出来”。

    1. 方法一般以小写字母打头,每一个后续的单词首字母大写,方法名中不应该有标点符号(包括下划线),有两个例外:
      1)可以用一些通用的大写字母缩写打头方法,比如PDF,TIFF等。
      2)可以用带下划线的前缀来命名私有方法或者类别中的方法。

    如果方法表示让对象执行一个动作,使用动词打头来命名,注意不要使用do,does这种多余的关键字,动词本身的暗示就足够了:

    //动词打头的方法表示让对象执行一个动作
    - (void)invokeWithTarget:(id)target;
    - (void)selectTabViewItem:(NSTabViewItem *)tabViewItem;
    
    1. 如果方法是为了获取对象的一个属性值,直接用属性名称来命名这个方法,注意不要添加get或者其他的动词前缀:
    //正确,使用属性名来命名方法
    - (NSSize)cellSize;
    
    //错误,添加了多余的动词前缀
    - (NSSize)calcCellSize;
    - (NSSize)getCellSize;
    
    1. 对于有多个参数的方法,务必在每一个参数前都添加关键词,关键词应当清晰说明参数的作用:
    //正确,保证每个参数都有关键词修饰
    - (void)sendAction:(SEL)aSelector toObject:(id)anObject forAllCells:(BOOL)flag;
    
    //错误,遗漏关键词
    - (void)sendAction:(SEL)aSelector :(id)anObject :(BOOL)flag;
    
    //正确
    - (id)viewWithTag:(NSInteger)aTag;
    
    //错误,关键词的作用不清晰
    - (id)taggedView:(int)aTag;
    
    1. 不要用and来连接两个参数,通常and用来表示方法执行了两个相对独立的操作(从设计上来说,这时候应该拆分成两个独立的方法):
    //错误,不要使用"and"来连接参数
    - (int)runModalForDirectory:(NSString *)path andFile:(NSString *)name andTypes:(NSArray *)fileTypes;
    
    //正确,使用"and"来表示两个相对独立的操作
    - (BOOL)openFile:(NSString *)fullPath withApplication:(NSString *)appName andDeactivate:(BOOL)flag;
    
    1. 方法的参数命名一些需要注意的地方:

    1)和方法名类似,参数的第一个字母小写,后面的每一个单词首字母大写;
    2)不要再方法名中使用类似pointer,ptr这样的字眼去表示指针,参数本身的类型足以说明;
    3)不要使用只有一两个字母的参数名;
    4)不要使用简写,拼出完整的单词
    下面列举了一些常用参数名:

    ...action:(SEL)aSelector
    ...alignment:(int)mode
    ...atIndex:(int)index
    ...content:(NSRect)aRect
    ...doubleValue:(double)aDouble
    ...floatValue:(float)aFloat
    ...font:(NSFont *)fontObj
    ...frame:(NSRect)frameRect
    ...intValue:(int)anInt
    ...keyEquivalent:(NSString *)charCode
    ...length:(int)numBytes
    ...point:(NSPoint)aPoint
    ...stringValue:(NSString *)aString
    ...tag:(int)anInt
    ...target:(id)anObject
    ...title:(NSString *)aString
    
    11.存取方法命名

    存取方法是指用来获取和设置类属性值的方法,属性的不同类型,对应着不同的存取方法规范:

    //属性是一个名词时的存取方法范式
    - (type)noun;
    - (void)setNoun:(type)aNoun;
    //栗子
    - (NSString *)title;
    - (void)setTitle:(NSString *)aTitle;
    
    //属性是一个形容词时存取方法的范式
    - (BOOL)isAdjective;
    - (void)setAdjective:(BOOL)flag;
    //栗子
    - (BOOL)isEditable;
    - (void)setEditable:(BOOL)flag;
    
    //属性是一个动词时存取方法的范式
    - (BOOL)verbObject;
    - (void)setVerbObject:(BOOL)flag;
    //栗子
    - (BOOL)showsAlpha;
    - (void)setShowsAlpha:(BOOL)flag;
    

    命名存取方法时不要将动词转化为被动形式来使用:

    //正确
    - (void)setAcceptsGlyphInfo:(BOOL)flag;
    - (BOOL)acceptsGlyphInfo;
    
    //错误,不要使用动词的被动形式
    - (void)setGlyphInfoAccepted:(BOOL)flag;
    - (BOOL)glyphInfoAccepted;
    

    可以使用can,should,will等词来协助表达存取方法的意思,但不要使用do,和does:

    //正确
    - (void)setCanHide:(BOOL)flag;
    - (BOOL)canHide;
    - (void)setShouldCloseDocument:(BOOL)flag;
    - (BOOL)shouldCloseDocument;
    
    //错误,不要使用"do"或者"does"
    - (void)setDoesAcceptGlyphInfo:(BOOL)flag;
    - (BOOL)doesAcceptGlyphInfo;
    

    为什么Objective-C中不适用get前缀来表示属性获取方法?因为get在Objective-C中通常只用来表示从函数指针返回值的函数:

    //三个参数都是作为函数的返回值来使用的,这样的函数名可以使用"get"前缀
    - (void)getLineDash:(float *)pattern count:(int *)count phase:(float *)phase;
    

    三、数据结构

    1. 应该使用可读性更好的语法糖来构造NSArray,NSDictionary等数据结构,避免使用冗长的alloc,init方法。
    2. 如果构造代码写在一行,需要在括号两端留有一个空格,使得被构造的元素于与构造语法区分开来:
    示例:
    //在语法糖的"[]"或者"{}"两端留有空格
    NSArray *array = @[ [foo description], @"Another String", [bar description] ];
    NSDictionary *dict = @{ NSForegroundColorAttributeName : [NSColor redColor] };
    
    
    1. 如果构造代码不写在一行内,构造元素需要使用两个空格来进行缩进,右括号]或者}写在新的一行,并且与调用语法糖那行代码的第一个非空字符对齐:
    示例:
    NSArray *array = @[
      @"This",
      @"is",
      @"an",
      @"array"
    ];
    
    NSDictionary *dictionary = @{
      NSFontAttributeName : [NSFont fontWithName:@"Helvetica-Bold" size:12],
      NSForegroundColorAttributeName : fontColor
    };
    
    1. 构造字典时,字典的Key和Value与中间的冒号:都要留有一个空格,多行书写时,也可以将Value对齐:
    //正确,冒号':'前后留有一个空格
    NSDictionary *option1 = @{
      NSFontAttributeName : [NSFont fontWithName:@"Helvetica-Bold" size:12],
      NSForegroundColorAttributeName : fontColor
    };
    
    //正确,按照Value来对齐
    NSDictionary *option2 = @{
      NSFontAttributeName :            [NSFont fontWithName:@"Arial" size:12],
      NSForegroundColorAttributeName : fontColor
    };
    
    //错误,冒号前应该有一个空格
    NSDictionary *wrong = @{
      AKey:       @"b",
      BLongerKey: @"c",
    };
    
    //错误,每一个元素要么单独成为一行,要么全部写在一行内
    NSDictionary *alsoWrong= @{ AKey : @"a",
                                BLongerKey : @"b" };
    
    //错误,在冒号前只能有一个空格,冒号后才可以考虑按照Value对齐
    NSDictionary *stillWrong = @{
      AKey       : @"b",
      BLongerKey : @"c",
    };
    

    四、协议及闭包

    1.协议(Protocols)

    在书写协议的时候注意用<>括起来的协议和类型名之间是没有空格的,比如IPCConnectHandler()<IPCPreconnectorDelegate>,这个规则适用所有书写协议的地方,包括函数声明、类声明、实例变量等等:

    @interface MyProtocoledClass : NSObject<NSWindowDelegate> {
     @private
        id<MyFancyDelegate> _delegate;
    }
    
    - (void)setDelegate:(id<MyFancyDelegate>)aDelegate;
    @end
    
    2.闭包(Block)

    根据block的长度,有不同的书写规则:
    1.较短的block可以写在一行内。
    2.如果分行显示的话,block的右括号}应该和调用block那行代码的第一个非空字符对齐。
    3.block内的代码采用4个空格的缩进。
    4.如果block过于庞大,应该单独声明成一个变量来使用。
    5.^和(之间,和{之间都没有空格,参数列表的右括号)和{之间有一个空格。

    示例:
    //较短的block写在一行内
    [operation setCompletionBlock:^{ [self onOperationDone]; }];
    
    //分行书写的block,内部使用4空格缩进
    [operation setCompletionBlock:^{
        [self.delegate newDataAvailable];
    }];
    
    //使用C语言API调用的block遵循同样的书写规则
    dispatch_async(_fileIOQueue, ^{
        NSString* path = [self sessionFilePath];
        if (path) {
          // ...
        }
    });
    
    //较长的block关键字可以缩进后在新行书写,注意block的右括号'}'和调用block那行代码的第一个非空字符对齐
    [[SessionService sharedService]
        loadWindowWithCompletionBlock:^(SessionWindow *window) {
            if (window) {
              [self windowDidLoad:window];
            } else {
              [self errorLoadingWindow];
            }
        }];
    
    //较长的block参数列表同样可以缩进后在新行书写
    [[SessionService sharedService]
        loadWindowWithCompletionBlock:
            ^(SessionWindow *window) {
                if (window) {
                  [self windowDidLoad:window];
                } else {
                  [self errorLoadingWindow];
                }
            }];
    
    //庞大的block应该单独定义成变量使用
    void (^largeBlock)(void) = ^{
        // ...
    };
    [_operationQueue addOperationWithBlock:largeBlock];
    
    //在一个调用中使用多个block,注意到他们不是像函数那样通过':'对齐的,而是同时进行了4个空格的缩进
    [myObject doSomethingWith:arg1
        firstBlock:^(Foo *a) {
            // ...
        }
        secondBlock:^(Bar *b) {
            // ...
        }];
    

    五、函数

    在很多场合仍然需要用到函数,比如说如果一个对象是一个单例,那么应该使用函数来代替类方法执行相关操作。

    1.函数书写

    1)函数名称一般带有缩写前缀,表示方法所在的框架。
    2)前缀后的单词以“驼峰”表示法显示,第一个单词首字母大写。
    3)函数名的第一个单词通常是一个动词,表示方法执行的操作:
    在-和(void)之间应该有一个空格,第一个大括号{的位置在函数所在行的末尾,同样应该有一个空格;最后一个大括号}单独放在最后一行。

    示例:
    - (void)writeVideoFrameWithData:(NSData *)frameData timeStamp:(int)timeStamp {
        ...
    }
    

    如果一个函数有多个参数或名称较长,应该将其按照「:」来对齐分行显示:

    - (id)initWithModel:(IPCModle)model
           ConnectType:(IPCConnectType)connectType
            Resolution:(IPCResolution)resolution
              AuthName:(NSString *)authName
              Password:(NSString *)password
                   MAC:(NSString *)mac
                  AzIp:(NSString *)az_ip
                 AzDns:(NSString *)az_dns
                 Token:(NSString *)token
                 Email:(NSString *)email
              Delegate:(id<IPCConnectHandlerDelegate>)delegate {
           ...
    }
    
    2.函数调用

    函数调用的格式和书写差不多,可以按照函数的长短来选择写在一行或者分成多行:

    示例:
    //写在一行
    [myObject doFooWith:arg1 name:arg2 error:arg3];
    
    //分行写,按照':'对齐
    [myObject doFooWith:arg1
                   name:arg2
                  error:arg3];
    
    //第一段名称过短的话后续可以进行缩进
    [myObj short:arg1
              longKeyword:arg2
        evenLongerKeyword:arg3
                    error:arg4];
    
    3.集合操作类方法

    有些对象管理着一系列其它对象或者元素的集合,需要使用类似“增删查改”的方法来对集合进行操作,这些方法的命名范式一般为:

    //集合操作范式
    - (void)addElement:(elementType)anObj;
    - (void)removeElement:(elementType)anObj;
    - (NSArray *)elements;
    
    //举例
    - (void)addLayoutManager:(NSLayoutManager *)obj;
    - (void)removeLayoutManager:(NSLayoutManager *)obj;
    - (NSArray *)layoutManagers;
    

    注意,如果返回的集合是无序的,使用NSSet来代替NSArray。如果需要将元素插入到特定的位置,使用类似于这样的命名:

    - (void)insertLayoutManager:(NSLayoutManager *)obj atIndex:(int)index;
    - (void)removeLayoutManagerAtIndex:(int)index;
    

    如果管理的集合元素中有指向管理对象的指针,要设置成weak类型以防止引用循环。

    下面是SDK中NSWindow类的集合操作方法:

    - (void)addChildWindow:(NSWindow *)childWin ordered:(NSWindowOrderingMode)place;
    - (void)removeChildWindow:(NSWindow *)childWin;
    - (NSArray *)childWindows;
    - (NSWindow *)parentWindow;
    - (void)setParentWindow:(NSWindow *)window;
    

    六、注释

    读没有注释代码的痛苦你我都体会过,好的注释不仅能让人轻松读懂你的程序,还能提升代码的逼格。注意注释是为了让别人看懂,而不是仅仅你自己。
    当需要注释时,注释应该用来解释这段特殊代码为什么要这样做。任何被使用的注释都必须保持最新或被删除。
    一般都避免使用块注释,因为代码尽可能做到自解释,只有当断断续续或几行代码时才需要注释。

    1.文件注释

    每一个文件都必须写文件注释,文件注释通常包含:
    1)文件所在模块
    2)作者信息
    3)历史版本信息
    4)版权信息
    5)文件包含的内容、作用
    示例:

    /*******************************************************************************
        Copyright (C), 2011-2013, Andrew Min Chang
    
        File name:  AMCCommonLib.h
        Author:     Andrew Chang (Zhang Min)
        E-mail:     LaplaceZhang@126.com
    
        Description:    
                This file provide some covenient tool in calling library tools. One can easily include
            library headers he wants by declaring the corresponding macros.
                I hope this file is not only a header, but also a useful Linux library note.
    
        History:
            2012-??-??: On about come date around middle of Year 2012, file created as "commonLib.h"
            2012-08-20: Add shared memory library; add message queue.
            2012-08-21: Add socket library (local)
            2012-08-22: Add math library
            2012-08-23: Add socket library (internet)
            2012-08-24: Add daemon function
            2012-10-10: Change file name as "AMCCommonLib.h"
            2012-12-04: Add UDP support in AMC socket library
            2013-01-07: Add basic data type such as "sint8_t"
            2013-01-18: Add CFG_LIB_STR_NUM.
            2013-01-22: Add CFG_LIB_TIMER.
            2013-01-22: Remove CFG_LIB_DATA_TYPE because there is already AMCDataTypes.h
    
        Copyright information:
                This file was intended to be under GPL protocol. However, I may use this library
            in my work as I am an employee. And my company may require me to keep it secret.
            Therefore, this file is neither open source nor under GPL control.
    
    ********************************************************************************/
    

    文件注释的格式通常不作要求,能清晰易读就可以了,但在整个工程中风格要统一。

    2.代码注释

    好的代码应该是“自解释”(self-documenting)的,但仍然需要详细的注释来说明参数的意义、返回值、功能以及可能的副作用。

    方法、函数、类、协议、类别的定义都需要注释,推荐采用Apple的标准注释风格,好处是可以在引用的地方alt+点击自动弹出注释,非常方便, 一些良好的注释:

    /**
     *  Create a new preconnector to replace the old one with given mac address.
     *  NOTICE: We DO NOT stop the old preconnector, so handle it by yourself.
     *
     *  @param type       Connect type the preconnector use.
     *  @param macAddress Preconnector's mac address.
     */
    - (void)refreshConnectorWithConnectType:(IPCConnectType)type  Mac:(NSString *)macAddress;
    
    /**
     *  Stop current preconnecting when application is going to background.
     */
    -(void)stopRunning;
    
    /**
     *  Get the COPY of cloud device with a given mac address.
     *
     *  @param macAddress Mac address of the device.
     *
     *  @return Instance of IPCCloudDevice.
     */
    -(IPCCloudDevice *)getCloudDeviceWithMac:(NSString *)macAddress;
    
    // A delegate for NSApplication to handle notifications about app
    // launch and shutdown. Owned by the main app controller.
    @interface MyAppDelegate : NSObject {
      ...
    }
    @end
    

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

    /** Delegate - Sent when failed to init connection, like p2p failed. */
    -(void)initConnectionDidFailed:(IPCConnectHandler *)handler;
    

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

    // Sometimes we need |count| to be less than zero.
    // Remember to call |StringWithoutSpaces("foo bar baz")|
    

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

    七、编码风格

    每个人都有自己的编码风格,这里总结了一些比较好的Cocoa编程风格和注意点。

    1.alloc和new

    尽管很多时候能用new代替alloc init方法,但这可能会导致调试内存时出现不可预料的问题。Cocoa的规范就是使用alloc init方法,使用new会让一些读者困惑。

    2.#import和#include

    import是Cocoa中常用的引用头文件的方式,它能自动防止重复引用文件,什么时候使用#import,什么时候使用#include呢?
    1)当引用的是一个Objective-C或者Objective-C++的头文件时,使用#import。
    2)当引用的是一个C或者C++的头文件时,使用#include,这时必须要保证被引用的文件提供了保护域(#define guard)。
    示例:

    #import <Cocoa/Cocoa.h>
    #include <CoreFoundation/CoreFoundation.h>
    #import "GTMFoo.h"
    #include "base/basictypes.h"
    

    为什么不全部使用#import呢?主要是为了保证代码在不同平台间共享时不出现问题。

    3. 框架的头文件

    每一个框架都会有一个和框架同名的头文件,它包含了框架内接口的所有引用,在使用框架的时候,应该直接引用这个根头文件,而不是其它子模块的头文件,即使是你只用到了其中的一小部分,编译器会自动完成优化的。

    //正确,引用根头文件
    #import <Foundation/Foundation.h>
    
    //错误,不要单独引用框架内的其它头文件
    #import <Foundation/NSArray.h>
    #import <Foundation/NSString.h>
    
    4.ARC和MRC

    除非想要兼容一些古董级的机器和操作系统,我们没有理由放弃使用ARC。在最新版的Xcode(6.2)中,ARC是自动打开的,所以直接使用就好了。

    5.Delegate的使用

    一个类的Delegate对象通常还引用着类本身,这样很容易造成引用循环的问题,所以类的Delegate属性要设置为弱引用。

    @property (nonatomic, weak) id <IPCConnectHandlerDelegate> delegate;
    
    6.nil检查

    因为在Objective-C中向nil对象发送命令是不会抛出异常或者导致崩溃的,只是完全的“什么都不干”,所以,只在程序中使用nil来做逻辑上的检查。

    另外,不要使用诸如nil == Object或者Object == nil的形式来判断。

    //正确,直接判断
    if (!objc) {
        ...
    }
    
    //错误,不要使用nil == Object的形式
    if (nil == objc) {
        ...
    }
    

    八、排版格式

    Objective-C是一门面向对象的动态编程语言,主要用于编写iOS和Mac应用程序。关于Objective-C的编码规范,苹果和谷歌都已经有很好的总结:

    相关文章

      网友评论

        本文标题:iOS -  Objective-C代码规范

        本文链接:https://www.haomeiwen.com/subject/okannrtx.html