zoukankan      html  css  js  c++  java
  • Objective-C开发编码规范【转载】

    概要

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

    • Apple Coding Guidelines for Cocoa

    • Google Objective-C Style Guide

    本文主要整合了对上述文档的翻译、作者自己的编程经验和其他的相关资料,为公司总结出一份通用的编码规范。

    代码格式

    使用空格而不是制表符Tab

    不要在工程里使用Tab键,使用空格来进行缩进。在Xcode > Preferences > Text Editing将Tab和自动缩进都设置为4个空格。(Google的标准是使用两个空格来缩进,但这里还是推荐使用Xcode默认的设置。)

    每一行的最大长度

    同样的,在Xcode > Preferences > Text Editing > Page guide at column:中将最大行长设置为80,过长的一行代码将会导致可读性问题。

    函数的书写

    一个典型的Objective-C函数应该是这样的:

    - (void)writeVideoFrameWithData:(NSData *)frameData timeStamp:(int)timeStamp {

    ...

    }

    在-和(void)之间应该有一个空格,第一个大括号{的位置在函数所在行的末尾,同样应该有一个空格。(我司的C语言规范要求是第一个大括号单独占一行,但考虑到OC较长的函数名和苹果SDK代码的风格,还是将大括号放在行末。)

    如果一个函数有特别多的参数或者名称很长,应该将其按照:来对齐分行显示:

    -(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;

    在分行时,如果第一段名称过短,后续名称可以以Tab的长度(4个空格)为单位进行缩进:

    - (void)short:(GTMFoo *)theFoo

    longKeyword:(NSRect)theRect

    evenLongerKeyword:(float)theInterval

    error:(NSError **)theError {

    ...

    }

    函数调用

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

    //写在一行

    [myObject doFooWith:arg1 name:arg2 error:arg3];

    //分行写,按照':'对齐

    [myObject doFooWith:arg1

    name:arg2

    error:arg3];

    //第一段名称过短的话后续可以进行缩进

    [myObj short:arg1

    longKeyword:arg2

    evenLongerKeyword:arg3

    error:arg4];

    以下写法是错误的:

    //错误,要么写在一行,要么全部分行

    [myObject doFooWith:arg1 name:arg2

    error:arg3];

    [myObject doFooWith:arg1

    name:arg2 error:arg3];

    //错误,按照':'来对齐,而不是关键字

    [myObject doFooWith:arg1

    name:arg2

    error:arg3];

    @public和@private标记符

    @public和@private标记符应该以一个空格来进行缩进:

    @interface MyClass : NSObject {

    @public

    ...

    @private

    ...

    }

    @end

    协议(Protocols)

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

    @interface MyProtocoledClass : NSObject<NSWindowDelegate> {

    @private

    id<MyFancyDelegate> _delegate;

    }

    - (void)setDelegate:(id<MyFancyDelegate>)aDelegate;

    @end

    闭包(Blocks)

    根据block的长度,有不同的书写规则:

    较短的block可以写在一行内。

    如果分行显示的话,block的右括号}应该和调用block那行代码的第一个非空字符对齐。

    block内的代码采用4个空格的缩进。

    如果block过于庞大,应该单独声明成一个变量来使用。

    ^和(之间,^和{之间都没有空格,参数列表的右括号)和{之间有一个空格。

    //较短的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) {

    // ...

    }];

    数据结构的语法糖

    应该使用可读性更好的语法糖来构造NSArray,NSDictionary等数据结构,避免使用冗长的alloc,init方法。

    如果构造代码写在一行,需要在括号两端留有一个空格,使得被构造的元素于与构造语法区分开来:

    //正确,在语法糖的"[]"或者"{}"两端留有空格

    NSArray *array = @[ [foo description], @"Another String", [bar description] ];

    NSDictionary *dict = @{ NSForegroundColorAttributeName : [NSColor redColor] };

    //不正确,不留有空格降低了可读性

    NSArray* array = @[[foo description], [bar description]];

    NSDictionary* dict = @{NSForegroundColorAttributeName: [NSColor redColor]};

    如果构造代码不写在一行内,构造元素需要使用两个空格来进行缩进,右括号]或者}写在新的一行,并且与调用语法糖那行代码的第一个非空字符对齐:

    NSArray *array = @[

    @"This",

    @"is",

    @"an",

    @"array"

    ];

    NSDictionary *dictionary = @{

    NSFontAttributeName : [NSFont fontWithName:@"Helvetica-Bold" size:12],

    NSForegroundColorAttributeName : fontColor

    };

    构造字典时,字典的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",

    };

    命名规范

    基本原则

    清晰

    命名应该尽可能的清晰和简洁,但在Objective-C中,清晰比简洁更重要。由于Xcode强大的自动补全功能,我们不必担心名称过长的问题。

    //清晰

    insertObject:atIndex:

    //不清晰,insert的对象类型和at的位置属性没有说明

    insert:at:

    //清晰

    removeObjectAtIndex:

    //不清晰,remove的对象类型没有说明,参数的作用没有说明

    remove:

    不要使用单词的简写,拼写出完整的单词:

    //清晰

    destinationSelection

    setBackgroundColor:

    //不清晰,不要使用简写

    destSel

    setBkgdColor:

    然而,有部分单词简写在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

    命名方法或者函数时要避免歧义

    //有歧义,是返回sendPort还是send一个Port?

    sendPort

    //有歧义,是返回一个名字属性的值还是display一个name的动作?

    displayName

    一致性

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

    使用前缀

    如果代码需要打包成Framework给别的工程使用,或者工程项目非常庞大,需要拆分成不同的模块,使用命名前缀是非常有用的。

    • 前缀由大写的字母缩写组成,比如Cocoa中NS前缀代表Founation框架中的类,IB则代表Interface Builder框架。

    • 可以在为类、协议、函数、常量以及typedef宏命名的时候使用前缀,但注意不要为成员变量或者方法使用前缀,因为他们本身就包含在类的命名空间内。

    • 命名前缀的时候不要和苹果SDK框架冲突。

    命名类和协议(Class&Protocol)

    类名以大写字母开头,应该包含一个名词来表示它代表的对象类型,同时可以加上必要的前缀,比如NSString, NSDate, NSScanner, NSApplication等等。

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

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

    命名头文件(Headers)

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

    • 如果头文件内只定义了单个类或者协议,直接用类名或者协议名来命名头文件,比如NSLocale.h定义了NSLocale类。

    • 如果头文件内定义了一系列的类、协议、类别,使用其中最主要的类名来命名头文件,比如NSString.h定义了NSString和NSMutableString。

    • 每一个Framework都应该有一个和框架同名的头文件,包含了框架中所有公共类头文件的引用,比如Foundation.h

    • Framework中有时候会实现在别的框架中类的类别扩展,这样的文件通常使用被扩展的框架名+Additions的方式来命名,比如NSBundleAdditions.h。

    命名方法(Methods)

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

    方法一般以小写字母打头,每一个后续的单词首字母大写,方法名中不应该有标点符号(包括下划线),有两个例外:

    可以用一些通用的大写字母缩写打头方法,比如PDF,TIFF等。

    可以用带下划线的前缀来命名私有方法或者类别中的方法。

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

    //动词打头的方法表示让对象执行一个动作

    - (void)invokeWithTarget:(id)target;

    - (void)selectTabViewItem:(NSTabViewItem *)tabViewItem;

    如果方法是为了获取对象的一个属性值,直接用属性名称来命名这个方法,注意不要添加get或者其他的动词前缀:

    //正确,使用属性名来命名方法

    - (NSSize)cellSize;

    //错误,添加了多余的动词前缀

    - (NSSize)calcCellSize;

    - (NSSize)getCellSize;

    对于有多个参数的方法,务必在每一个参数前都添加关键词,关键词应当清晰说明参数的作用:

    //正确,保证每个参数都有关键词修饰

    - (void)sendAction:(SEL)aSelector toObject:(id)anObject forAllCells:(BOOL)flag;

    //错误,遗漏关键词

    - (void)sendAction:(SEL)aSelector <img src="http://ios.jobbole.com/wp-includes/images/smilies/icon_sad.gif" alt=":(" class="wp-smiley"> id)anObject <img src="http://ios.jobbole.com/wp-includes/images/smilies/icon_sad.gif" alt=":(" class="wp-smiley"> BOOL)flag;

    //正确

    - (id)viewWithTag:(NSInteger)aTag;

    //错误,关键词的作用不清晰

    - (id)taggedView:(int)aTag;

    不要用and来连接两个参数,通常and用来表示方法执行了两个相对独立的操作(从设计上来说,这时候应该拆分成两个独立的方法):

    //错误,不要使用"and"来连接参数

    - (int)runModalForDirectory:(NSString *)path andFile:(NSString *)name andTypes:(NSArray *)fileTypes;

    //正确,使用"and"来表示两个相对独立的操作

    - (BOOL)openFile:(NSString *)fullPath withApplication:(NSString *)appName andDeactivate:(BOOL)flag;

    方法的参数命名也有一些需要注意的地方:

    • 和方法名类似,参数的第一个字母小写,后面的每一个单词首字母大写

    • 不要再方法名中使用类似pointer,ptr这样的字眼去表示指针,参数本身的类型足以说明

    • 不要使用只有一两个字母的参数名

    • 不要使用简写,拼出完整的单词

    下面列举了一些常用参数名:

    ...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

    存取方法(Accessor Methods)

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

    //属性是一个名词时的存取方法范式

    - (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;

    命名委托(Delegate)

    当特定的事件发生时,对象会触发它注册的委托方法。委托是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;

    集合操作类方法(Collection Methods)

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

    //集合操作范式

    - (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;

    命名函数(Functions)

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

    函数的命名和方法有一些不同,主要是:

    • 函数名称一般带有缩写前缀,表示方法所在的框架。

    • 前缀后的单词以“驼峰”表示法显示,第一个单词首字母大写。

    函数名的第一个单词通常是一个动词,表示方法执行的操作:

    NSHighlightRect

    NSDeallocateObject

    如果函数返回其参数的某个属性,省略动词:

    unsigned int NSEventMaskFromType(NSEventType type)

    float NSHeight(NSRect aRect)

    如果函数通过指针参数来返回值,需要在函数名中使用Get:

    const char *NSGetSizeAndAlignment(const char *typePtr, unsigned int *sizep, unsigned int *alignp)

    函数的返回类型是BOOL时的命名:

    BOOL NSDecimalIsNotANumber(const NSDecimal *decimal)

    命名属性和实例变量(Properties&Instance Variables)

    属性和对象的存取方法相关联,属性的第一个字母小写,后续单词首字母大写,不必添加前缀。属性按功能命名成名词或者动词:

    //名词属性

    @property (strong) NSString *title;

    //动词属性

    @property (assign) BOOL showsAlpha;

    属性也可以命名成形容词,这时候通常会指定一个带有is前缀的get方法来提高可读性:

    @property (assign, getter=isEditable) BOOL editable;

    命名实例变量,在变量名前加上_前缀(有些有历史的代码会将_放在后面),其它和命名属性一样:

    @implementation MyClass {

    BOOL _showsTitle;

    }

    一般来说,类需要对使用者隐藏数据存储的细节,所以不要将实例方法定义成公共可访问的接口,可以使用@private,@protected前缀。

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

    命名常量(Constants)

    如果要定义一组相关的常量,尽量使用枚举类型(enumerations),枚举类型的命名规则和函数的命名规则相同。 建议使用 NS_ENUM 和 NS_OPTIONS 宏来定义枚举类型,参见官方的 Adopting Modern Objective-C 一文:

    //定义一个枚举

    typedef NS_ENUM(NSInteger, NSMatrixMode) {

    NSRadioModeMatrix,

    NSHighlightModeMatrix,

    NSListModeMatrix,

    NSTrackModeMatrix

    };

    定义bit map:

    typedef NS_OPTIONS(NSUInteger, NSWindowMask) {

    NSBorderlessWindowMask = 0,

    NSTitledWindowMask = 1 << 0,

    NSClosableWindowMask = 1 << 1,

    NSMiniaturizableWindowMask = 1 << 2,

    NSResizableWindowMask = 1 << 3

    };

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

    const float NSLightGray;

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

    #ifdef DEBUG

    注意到一般由编译器定义的宏会在前后都有一个__,比如__MACH__。

    命名通知(Notifications)

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

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

    </code>

    栗子:

    NSApplicationDidBecomeActiveNotification

    NSWindowDidMiniaturizeNotification

    NSTextViewDidChangeSelectionNotification

    NSColorPanelColorDidChangeNotification

    注释

    读没有注释代码的痛苦你我都体会过,好的注释不仅能让人轻松读懂你的程序,还能提升代码的逼格。注意注释是为了让别人看懂,而不是仅仅你自己。

    文件注释

    每一个文件都必须写文件注释,文件注释通常包含

    • 文件所在模块

    • 作者信息

    • 历史版本信息

    • 版权信息

    • 文件包含的内容,作用

    一段良好文件注释的栗子:

    /*******************************************************************************

    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.

    ********************************************************************************/

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

    代码注释

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

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

    有很多可以自动生成注释格式的插件,推荐使用VVDocumenter:

    一些良好的注释:

    /**

    * 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")|

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

  • 相关阅读:
    【BZOJ4566】[HAOI2016]找相同字符
    【BZOJ3238】[AHOI2013]差异
    【BZOJ4698】[SDOI2008]Sandy的卡片
    后缀数组(SA)总结
    【HDU3117】Fibonacci Numbers
    线性常系数齐次递推总结
    【HDU4565】So Easy!
    【BZOJ3144】[HNOI2013]切糕
    【BZOJ1070】[SCOI2007]修车
    【LOJ6433】【PKUSC2018】最大前缀和
  • 原文地址:https://www.cnblogs.com/zhangliukou/p/4493884.html
Copyright © 2011-2022 走看看