OC代碼規(guī)范總結(jié)

Objective-C Coding Guidelines In Chinese

規(guī)范.jpeg

Objective-C編碼規(guī)范，內(nèi)容來自蘋果、谷歌的文檔翻譯，『博愛』的編碼經(jīng)驗(yàn)和對(duì)其它資料的總結(jié)。
詳情可前往：開源項(xiàng)目『BABaseProject』

概要

Objective-C是一門面向?qū)ο蟮膭?dòng)態(tài)編程語言，主要用于編寫iOS和Mac應(yīng)用程序。關(guān)于Objective-C的編碼規(guī)范，蘋果和谷歌都已經(jīng)有很好的總結(jié)：

本文主要整合了對(duì)上述文檔的翻譯、作者自己的編程經(jīng)驗(yàn)和其他的相關(guān)資料，為公司總結(jié)出一份通用的編碼規(guī)范。

代碼格式

使用空格而不是制表符Tab

不要在工程里使用Tab鍵，使用空格來進(jìn)行縮進(jìn)。在Xcode > Preferences > Text Editing將Tab和自動(dòng)縮進(jìn)都設(shè)置為4個(gè)空格。（Google的標(biāo)準(zhǔn)是使用兩個(gè)空格來縮進(jìn)，但這里還是推薦使用Xcode默認(rèn)的設(shè)置。）

每一行的最大長度

同樣的，在Xcode > Preferences > Text Editing > Page guide at column:中將最大行長設(shè)置為80，過長的一行代碼將會(huì)導(dǎo)致可讀性問題。

函數(shù)的書寫

一個(gè)典型的Objective-C函數(shù)應(yīng)該是這樣的：

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

在-和(void)之間應(yīng)該有一個(gè)空格，第一個(gè)大括號(hào){的位置在函數(shù)所在行的末尾，同樣應(yīng)該有一個(gè)空格。（我司的C語言規(guī)范要求是第一個(gè)大括號(hào)單獨(dú)占一行，但考慮到OC較長的函數(shù)名和蘋果SDK代碼的風(fēng)格，還是將大括號(hào)放在行末。）

如果一個(gè)函數(shù)有特別多的參數(shù)或者名稱很長，應(yīng)該將其按照:來對(duì)齊分行顯示：

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

在分行時(shí)，如果第一段名稱過短，后續(xù)名稱可以以Tab的長度（4個(gè)空格）為單位進(jìn)行縮進(jìn)：

- (void)short:(GTMFoo *)theFoo
        longKeyword:(NSRect)theRect
  evenLongerKeyword:(float)theInterval
              error:(NSError **)theError {
    ...
}

函數(shù)調(diào)用

函數(shù)調(diào)用的格式和書寫差不多，可以按照函數(shù)的長短來選擇寫在一行或者分成多行：

//寫在一行
[myObject doFooWith:arg1 name:arg2 error:arg3];

//分行寫，按照':'對(duì)齊
[myObject doFooWith:arg1
               name:arg2
              error:arg3];

//第一段名稱過短的話后續(xù)可以進(jìn)行縮進(jìn)
[myObj short:arg1
          longKeyword:arg2
    evenLongerKeyword:arg3
                error:arg4];

以下寫法是錯(cuò)誤的：

//錯(cuò)誤，要么寫在一行，要么全部分行
[myObject doFooWith:arg1 name:arg2
              error:arg3];
[myObject doFooWith:arg1
               name:arg2 error:arg3];

//錯(cuò)誤，按照':'來對(duì)齊，而不是關(guān)鍵字
[myObject doFooWith:arg1
          name:arg2
          error:arg3];

@public和@private標(biāo)記符

@public和@private標(biāo)記符應(yīng)該以一個(gè)空格來進(jìn)行縮進(jìn)：

@interface MyClass : NSObject {
 @public
  ...
 @private
  ...
}
@end

協(xié)議（Protocols）

在書寫協(xié)議的時(shí)候注意用<>括起來的協(xié)議和類型名之間是沒有空格的，比如IPCConnectHandler()<IPCPreconnectorDelegate>,這個(gè)規(guī)則適用所有書寫協(xié)議的地方，包括函數(shù)聲明、類聲明、實(shí)例變量等等：

@interface MyProtocoledClass : NSObject<NSWindowDelegate> {
 @private
    id<MyFancyDelegate> _delegate;
}

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

閉包（Blocks）

根據(jù)block的長度，有不同的書寫規(guī)則：

  • 較短的block可以寫在一行內(nèi)。
  • 如果分行顯示的話，block的右括號(hào)}應(yīng)該和調(diào)用block那行代碼的第一個(gè)非空字符對(duì)齊。
  • block內(nèi)的代碼采用4個(gè)空格的縮進(jìn)。
  • 如果block過于龐大，應(yīng)該單獨(dú)聲明成一個(gè)變量來使用。
  • ^和(之間，^和{之間都沒有空格，參數(shù)列表的右括號(hào))和{之間有一個(gè)空格。
//較短的block寫在一行內(nèi)
[operation setCompletionBlock:^{ [self onOperationDone]; }];

//分行書寫的block，內(nèi)部使用4空格縮進(jìn)
[operation setCompletionBlock:^{
    [self.delegate newDataAvailable];
}];

//使用C語言API調(diào)用的block遵循同樣的書寫規(guī)則
dispatch_async(_fileIOQueue, ^{
    NSString* path = [self sessionFilePath];
    if (path) {
      // ...
    }
});

//較長的block關(guān)鍵字可以縮進(jìn)后在新行書寫，注意block的右括號(hào)'}'和調(diào)用block那行代碼的第一個(gè)非空字符對(duì)齊
[[SessionService sharedService]
    loadWindowWithCompletionBlock:^(SessionWindow *window) {
        if (window) {
          [self windowDidLoad:window];
        } else {
          [self errorLoadingWindow];
        }
    }];

//較長的block參數(shù)列表同樣可以縮進(jìn)后在新行書寫
[[SessionService sharedService]
    loadWindowWithCompletionBlock:
        ^(SessionWindow *window) {
            if (window) {
              [self windowDidLoad:window];
            } else {
              [self errorLoadingWindow];
            }
        }];

//龐大的block應(yīng)該單獨(dú)定義成變量使用
void (^largeBlock)(void) = ^{
    // ...
};
[_operationQueue addOperationWithBlock:largeBlock];

//在一個(gè)調(diào)用中使用多個(gè)block，注意到他們不是像函數(shù)那樣通過':'對(duì)齊的，而是同時(shí)進(jìn)行了4個(gè)空格的縮進(jìn)
[myObject doSomethingWith:arg1
    firstBlock:^(Foo *a) {
        // ...
    }
    secondBlock:^(Bar *b) {
        // ...
    }];

數(shù)據(jù)結(jié)構(gòu)的語法糖

應(yīng)該使用可讀性更好的語法糖來構(gòu)造NSArray，NSDictionary等數(shù)據(jù)結(jié)構(gòu)，避免使用冗長的alloc,init方法。

如果構(gòu)造代碼寫在一行，需要在括號(hào)兩端留有一個(gè)空格，使得被構(gòu)造的元素于與構(gòu)造語法區(qū)分開來：

//正確，在語法糖的"[]"或者"{}"兩端留有空格
NSArray *array = @[ [foo description], @"Another String", [bar description] ];
NSDictionary *dict = @{ NSForegroundColorAttributeName : [NSColor redColor] };

//不正確，不留有空格降低了可讀性
NSArray* array = @[[foo description], [bar description]];
NSDictionary* dict = @{NSForegroundColorAttributeName: [NSColor redColor]};

如果構(gòu)造代碼不寫在一行內(nèi)，構(gòu)造元素需要使用兩個(gè)空格來進(jìn)行縮進(jìn)，右括號(hào)]或者}寫在新的一行，并且與調(diào)用語法糖那行代碼的第一個(gè)非空字符對(duì)齊：

NSArray *array = @[
  @"This",
  @"is",
  @"an",
  @"array"
];

NSDictionary *dictionary = @{
  NSFontAttributeName : [NSFont fontWithName:@"Helvetica-Bold" size:12],
  NSForegroundColorAttributeName : fontColor
};

構(gòu)造字典時(shí)，字典的Key和Value與中間的冒號(hào):都要留有一個(gè)空格，多行書寫時(shí)，也可以將Value對(duì)齊：

//正確，冒號(hào)':'前后留有一個(gè)空格
NSDictionary *option1 = @{
  NSFontAttributeName : [NSFont fontWithName:@"Helvetica-Bold" size:12],
  NSForegroundColorAttributeName : fontColor
};

//正確，按照Value來對(duì)齊
NSDictionary *option2 = @{
  NSFontAttributeName :            [NSFont fontWithName:@"Arial" size:12],
  NSForegroundColorAttributeName : fontColor
};

//錯(cuò)誤，冒號(hào)前應(yīng)該有一個(gè)空格
NSDictionary *wrong = @{
  AKey:       @"b",
  BLongerKey: @"c",
};

//錯(cuò)誤，每一個(gè)元素要么單獨(dú)成為一行，要么全部寫在一行內(nèi)
NSDictionary *alsoWrong= @{ AKey : @"a",
                            BLongerKey : @"b" };

//錯(cuò)誤，在冒號(hào)前只能有一個(gè)空格，冒號(hào)后才可以考慮按照Value對(duì)齊
NSDictionary *stillWrong = @{
  AKey       : @"b",
  BLongerKey : @"c",
};

命名規(guī)范

基本原則

清晰

命名應(yīng)該盡可能的清晰和簡潔，但在Objective-C中，清晰比簡潔更重要。由于Xcode強(qiáng)大的自動(dòng)補(bǔ)全功能，我們不必?fù)?dān)心名稱過長的問題。

//清晰
insertObject:atIndex:

//不清晰，insert的對(duì)象類型和at的位置屬性沒有說明
insert:at:

//清晰
removeObjectAtIndex:

//不清晰，remove的對(duì)象類型沒有說明，參數(shù)的作用沒有說明
remove:

不要使用單詞的簡寫，拼寫出完整的單詞：

//清晰
destinationSelection
setBackgroundColor:

//不清晰，不要使用簡寫
destSel
setBkgdColor:

然而，有部分單詞簡寫在Objective-C編碼過程中是非常常用的，以至于成為了一種規(guī)范，這些簡寫可以在代碼中直接使用，下面列舉了部分：

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

命名方法或者函數(shù)時(shí)要避免歧義

//有歧義，是返回sendPort還是send一個(gè)Port？
sendPort

//有歧義，是返回一個(gè)名字屬性的值還是display一個(gè)name的動(dòng)作？
displayName

一致性

整個(gè)工程的命名風(fēng)格要保持一致性，最好和蘋果SDK的代碼保持統(tǒng)一。不同類中完成相似功能的方法應(yīng)該叫一樣的名字，比如我們總是用count來返回集合的個(gè)數(shù)，不能在A類中使用count而在B類中使用getNumber。

使用前綴

如果代碼需要打包成Framework給別的工程使用，或者工程項(xiàng)目非常龐大，需要拆分成不同的模塊，使用命名前綴是非常有用的。

  • 前綴由大寫的字母縮寫組成，比如Cocoa中NS前綴代表Founation框架中的類，IB則代表Interface Builder框架。

  • 可以在為類、協(xié)議、函數(shù)、常量以及typedef宏命名的時(shí)候使用前綴，但注意不要為成員變量或者方法使用前綴，因?yàn)樗麄儽旧砭桶陬惖拿臻g內(nèi)。

  • 命名前綴的時(shí)候不要和蘋果SDK框架沖突。

命名類和協(xié)議（Class&Protocol）

類名以大寫字母開頭，應(yīng)該包含一個(gè)名詞來表示它代表的對(duì)象類型，同時(shí)可以加上必要的前綴，比如NSString, NSDate, NSScanner, NSApplication等等。

而協(xié)議名稱應(yīng)該清晰地表示它所執(zhí)行的行為，而且要和類名區(qū)別開來，所以通常使用ing詞尾來命名一個(gè)協(xié)議，比如NSCopying,NSLocking。

有些協(xié)議本身包含了很多不相關(guān)的功能，主要用來為某一特定類服務(wù)，這時(shí)候可以直接用類名來命名這個(gè)協(xié)議，比如NSObject協(xié)議，它包含了id對(duì)象在生存周期內(nèi)的一系列方法。

命名頭文件（Headers）

源碼的頭文件名應(yīng)該清晰地暗示它的功能和包含的內(nèi)容：

  • 如果頭文件內(nèi)只定義了單個(gè)類或者協(xié)議，直接用類名或者協(xié)議名來命名頭文件，比如NSLocale.h定義了NSLocale類。

  • 如果頭文件內(nèi)定義了一系列的類、協(xié)議、類別，使用其中最主要的類名來命名頭文件，比如NSString.h定義了NSString和NSMutableString。

  • 每一個(gè)Framework都應(yīng)該有一個(gè)和框架同名的頭文件，包含了框架中所有公共類頭文件的引用，比如Foundation.h

  • Framework中有時(shí)候會(huì)實(shí)現(xiàn)在別的框架中類的類別擴(kuò)展，這樣的文件通常使用被擴(kuò)展的框架名+Additions的方式來命名，比如NSBundleAdditions.h。

命名方法（Methods）

Objective-C的方法名通常都比較長，這是為了讓程序有更好地可讀性，按蘋果的說法“好的方法名應(yīng)當(dāng)可以以一個(gè)句子的形式朗讀出來”。

方法一般以小寫字母打頭，每一個(gè)后續(xù)的單詞首字母大寫，方法名中不應(yīng)該有標(biāo)點(diǎn)符號(hào)（包括下劃線），有兩個(gè)例外：

  • 可以用一些通用的大寫字母縮寫打頭方法，比如PDF,TIFF等。
  • 可以用帶下劃線的前綴來命名私有方法或者類別中的方法。

如果方法表示讓對(duì)象執(zhí)行一個(gè)動(dòng)作，使用動(dòng)詞打頭來命名，注意不要使用do，does這種多余的關(guān)鍵字，動(dòng)詞本身的暗示就足夠了：

//動(dòng)詞打頭的方法表示讓對(duì)象執(zhí)行一個(gè)動(dòng)作
- (void)invokeWithTarget:(id)target;
- (void)selectTabViewItem:(NSTabViewItem *)tabViewItem;

如果方法是為了獲取對(duì)象的一個(gè)屬性值，直接用屬性名稱來命名這個(gè)方法，注意不要添加get或者其他的動(dòng)詞前綴：

//正確，使用屬性名來命名方法
- (NSSize)cellSize;

//錯(cuò)誤，添加了多余的動(dòng)詞前綴
- (NSSize)calcCellSize;
- (NSSize)getCellSize;

對(duì)于有多個(gè)參數(shù)的方法，務(wù)必在每一個(gè)參數(shù)前都添加關(guān)鍵詞，關(guān)鍵詞應(yīng)當(dāng)清晰說明參數(shù)的作用：

//正確，保證每個(gè)參數(shù)都有關(guān)鍵詞修飾
- (void)sendAction:(SEL)aSelector toObject:(id)anObject forAllCells:(BOOL)flag;

//錯(cuò)誤，遺漏關(guān)鍵詞
- (void)sendAction:(SEL)aSelector :(id)anObject :(BOOL)flag;

//正確
- (id)viewWithTag:(NSInteger)aTag;

//錯(cuò)誤，關(guān)鍵詞的作用不清晰
- (id)taggedView:(int)aTag;

不要用and來連接兩個(gè)參數(shù)，通常and用來表示方法執(zhí)行了兩個(gè)相對(duì)獨(dú)立的操作（從設(shè)計(jì)上來說，這時(shí)候應(yīng)該拆分成兩個(gè)獨(dú)立的方法）：

//錯(cuò)誤，不要使用"and"來連接參數(shù)
- (int)runModalForDirectory:(NSString *)path andFile:(NSString *)name andTypes:(NSArray *)fileTypes;

//正確，使用"and"來表示兩個(gè)相對(duì)獨(dú)立的操作
- (BOOL)openFile:(NSString *)fullPath withApplication:(NSString *)appName andDeactivate:(BOOL)flag;

方法的參數(shù)命名也有一些需要注意的地方:

  • 和方法名類似，參數(shù)的第一個(gè)字母小寫，后面的每一個(gè)單詞首字母大寫
  • 不要再方法名中使用類似pointer,ptr這樣的字眼去表示指針，參數(shù)本身的類型足以說明
  • 不要使用只有一兩個(gè)字母的參數(shù)名
  • 不要使用簡寫，拼出完整的單詞

下面列舉了一些常用參數(shù)名：

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

存取方法是指用來獲取和設(shè)置類屬性值的方法，屬性的不同類型，對(duì)應(yīng)著不同的存取方法規(guī)范：

//屬性是一個(gè)名詞時(shí)的存取方法范式
- (type)noun;
- (void)setNoun:(type)aNoun;
//栗子
- (NSString *)title;
- (void)setTitle:(NSString *)aTitle;

//屬性是一個(gè)形容詞時(shí)存取方法的范式
- (BOOL)isAdjective;
- (void)setAdjective:(BOOL)flag;
//栗子
- (BOOL)isEditable;
- (void)setEditable:(BOOL)flag;

//屬性是一個(gè)動(dòng)詞時(shí)存取方法的范式
- (BOOL)verbObject;
- (void)setVerbObject:(BOOL)flag;
//栗子
- (BOOL)showsAlpha;
- (void)setShowsAlpha:(BOOL)flag;

命名存取方法時(shí)不要將動(dòng)詞轉(zhuǎn)化為被動(dòng)形式來使用：

//正確
- (void)setAcceptsGlyphInfo:(BOOL)flag;
- (BOOL)acceptsGlyphInfo;

//錯(cuò)誤，不要使用動(dòng)詞的被動(dòng)形式
- (void)setGlyphInfoAccepted:(BOOL)flag;
- (BOOL)glyphInfoAccepted;

可以使用can,should,will等詞來協(xié)助表達(dá)存取方法的意思，但不要使用do,和does：

//正確
- (void)setCanHide:(BOOL)flag;
- (BOOL)canHide;
- (void)setShouldCloseDocument:(BOOL)flag;
- (BOOL)shouldCloseDocument;

//錯(cuò)誤，不要使用"do"或者"does"
- (void)setDoesAcceptGlyphInfo:(BOOL)flag;
- (BOOL)doesAcceptGlyphInfo;

為什么Objective-C中不適用get前綴來表示屬性獲取方法？因?yàn)?code>get在Objective-C中通常只用來表示從函數(shù)指針返回值的函數(shù)：

//三個(gè)參數(shù)都是作為函數(shù)的返回值來使用的，這樣的函數(shù)名可以使用"get"前綴
- (void)getLineDash:(float *)pattern count:(int *)count phase:(float *)phase;

命名委托（Delegate）

當(dāng)特定的事件發(fā)生時(shí)，對(duì)象會(huì)觸發(fā)它注冊(cè)的委托方法。委托是Objective-C中常用的傳遞消息的方式。委托有它固定的命名范式。

一個(gè)委托方法的第一個(gè)參數(shù)是觸發(fā)它的對(duì)象，第一個(gè)關(guān)鍵詞是觸發(fā)對(duì)象的類名，除非委托方法只有一個(gè)名為sender的參數(shù)：

//第一個(gè)關(guān)鍵詞為觸發(fā)委托的類名
- (BOOL)tableView:(NSTableView *)tableView shouldSelectRow:(int)row;
- (BOOL)application:(NSApplication *)sender openFile:(NSString *)filename;

//當(dāng)只有一個(gè)"sender"參數(shù)時(shí)可以省略類名
- (BOOL)applicationOpenUntitledFile:(NSApplication *)sender;

根據(jù)委托方法觸發(fā)的時(shí)機(jī)和目的，使用should,will,did等關(guān)鍵詞

- (void)browserDidScroll:(NSBrowser *)sender;

- (NSUndoManager *)windowWillReturnUndoManager:(NSWindow *)window;、

- (BOOL)windowShouldClose:(id)sender;

集合操作類方法（Collection Methods）

有些對(duì)象管理著一系列其它對(duì)象或者元素的集合，需要使用類似“增刪查改”的方法來對(duì)集合進(jìn)行操作，這些方法的命名范式一般為：

//集合操作范式
- (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;

如果管理的集合元素中有指向管理對(duì)象的指針，要設(shè)置成weak類型以防止引用循環(huán)。

下面是SDK中NSWindow類的集合操作方法：

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

命名函數(shù)（Functions）

在很多場(chǎng)合仍然需要用到函數(shù)，比如說如果一個(gè)對(duì)象是一個(gè)單例，那么應(yīng)該使用函數(shù)來代替類方法執(zhí)行相關(guān)操作。

函數(shù)的命名和方法有一些不同，主要是：

  • 函數(shù)名稱一般帶有縮寫前綴，表示方法所在的框架。
  • 前綴后的單詞以“駝峰”表示法顯示，第一個(gè)單詞首字母大寫。

函數(shù)名的第一個(gè)單詞通常是一個(gè)動(dòng)詞，表示方法執(zhí)行的操作：

NSHighlightRect
NSDeallocateObject

如果函數(shù)返回其參數(shù)的某個(gè)屬性，省略動(dòng)詞：

unsigned int NSEventMaskFromType(NSEventType type)
float NSHeight(NSRect aRect)

如果函數(shù)通過指針參數(shù)來返回值，需要在函數(shù)名中使用Get：

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

函數(shù)的返回類型是BOOL時(shí)的命名：

BOOL NSDecimalIsNotANumber(const NSDecimal *decimal)

命名屬性和實(shí)例變量（Properties&Instance Variables）

屬性和對(duì)象的存取方法相關(guān)聯(lián)，屬性的第一個(gè)字母小寫，后續(xù)單詞首字母大寫，不必添加前綴。屬性按功能命名成名詞或者動(dòng)詞：

//名詞屬性
@property (strong) NSString *title;

//動(dòng)詞屬性
@property (assign) BOOL showsAlpha;

屬性也可以命名成形容詞，這時(shí)候通常會(huì)指定一個(gè)帶有is前綴的get方法來提高可讀性：

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

命名實(shí)例變量，在變量名前加上_前綴（有些有歷史的代碼會(huì)將_放在后面），其它和命名屬性一樣：

@implementation MyClass {
    BOOL _showsTitle;
}

一般來說，類需要對(duì)使用者隱藏?cái)?shù)據(jù)存儲(chǔ)的細(xì)節(jié)，所以不要將實(shí)例方法定義成公共可訪問的接口，可以使用@private，@protected前綴。

按蘋果的說法，不建議在除了init和dealloc方法以外的地方直接訪問實(shí)例變量，但很多人認(rèn)為直接訪問會(huì)讓代碼更加清晰可讀，只在需要計(jì)算或者執(zhí)行操作的時(shí)候才使用存取方法訪問，我就是這種習(xí)慣，所以這里不作要求。

命名常量（Constants）

如果要定義一組相關(guān)的常量，盡量使用枚舉類型（enumerations），枚舉類型的命名規(guī)則和函數(shù)的命名規(guī)則相同。
建議使用 NS_ENUM 和 NS_OPTIONS 宏來定義枚舉類型，參見官方的 Adopting Modern Objective-C 一文：

//定義一個(gè)枚舉
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定義浮點(diǎn)型或者單個(gè)的整數(shù)型常量，如果要定義一組相關(guān)的整數(shù)常量，應(yīng)該優(yōu)先使用枚舉。常量的命名規(guī)范和函數(shù)相同：

const float NSLightGray;

不要使用#define宏來定義常量，如果是整型常量，盡量使用枚舉，浮點(diǎn)型常量，使用const定義。#define通常用來給編譯器決定是否編譯某塊代碼，比如常用的：

#ifdef DEBUG

注意到一般由編譯器定義的宏會(huì)在前后都有一個(gè)__，比如__MACH__。

命名通知（Notifications）

通知常用于在模塊間傳遞消息，所以通知要盡可能地表示出發(fā)生的事件，通知的命名范式是：

[觸發(fā)通知的類名] + [Did | Will] + [動(dòng)作] + Notification

栗子：

NSApplicationDidBecomeActiveNotification
NSWindowDidMiniaturizeNotification
NSTextViewDidChangeSelectionNotification
NSColorPanelColorDidChangeNotification

注釋

讀沒有注釋代碼的痛苦你我都體會(huì)過，好的注釋不僅能讓人輕松讀懂你的程序，還能提升代碼的逼格。注意注釋是為了讓別人看懂，而不是僅僅你自己。

文件注釋

每一個(gè)文件都必須寫文件注釋，文件注釋通常包含

  • 文件所在模塊
  • 作者信息
  • 歷史版本信息
  • 版權(quán)信息
  • 文件包含的內(nèi)容，作用

一段良好文件注釋的栗子：

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

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

文件注釋的格式通常不作要求，能清晰易讀就可以了，但在整個(gè)工程中風(fēng)格要統(tǒng)一。

代碼注釋

好的代碼應(yīng)該是“自解釋”（self-documenting）的，但仍然需要詳細(xì)的注釋來說明參數(shù)的意義、返回值、功能以及可能的副作用。

方法、函數(shù)、類、協(xié)議、類別的定義都需要注釋，推薦采用Apple的標(biāo)準(zhǔn)注釋風(fēng)格，好處是可以在引用的地方alt+點(diǎn)擊自動(dòng)彈出注釋，非常方便, 一些良好的注釋：

/**
 *  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

協(xié)議、委托的注釋要明確說明其被觸發(fā)的條件：

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

如果在注釋中要引用參數(shù)名或者方法函數(shù)名，使用||將參數(shù)或者方法括起來以避免歧義：

// Sometimes we need |count| to be less than zero.

// Remember to call |StringWithoutSpaces("foo bar baz")|

定義在頭文件里的接口方法、屬性必須要有注釋！

編碼風(fēng)格

每個(gè)人都有自己的編碼風(fēng)格，這里總結(jié)了一些比較好的Cocoa編程風(fēng)格和注意點(diǎn)。

不要使用new方法

盡管很多時(shí)候能用new代替alloc init方法，但這可能會(huì)導(dǎo)致調(diào)試內(nèi)存時(shí)出現(xiàn)不可預(yù)料的問題。Cocoa的規(guī)范就是使用alloc init方法，使用new會(huì)讓一些讀者困惑。

Public API要盡量簡潔

共有接口要設(shè)計(jì)的簡潔，滿足核心的功能需求就可以了。不要設(shè)計(jì)很少會(huì)被用到，但是參數(shù)極其復(fù)雜的API。如果要定義復(fù)雜的方法，使用類別或者類擴(kuò)展。

#import和#include

#import是Cocoa中常用的引用頭文件的方式，它能自動(dòng)防止重復(fù)引用文件，什么時(shí)候使用#import，什么時(shí)候使用#include呢？

  • 當(dāng)引用的是一個(gè)Objective-C或者Objective-C++的頭文件時(shí)，使用#import
  • 當(dāng)引用的是一個(gè)C或者C++的頭文件時(shí)，使用#include，這時(shí)必須要保證被引用的文件提供了保護(hù)域（#define guard）。

栗子：

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

為什么不全部使用#import呢？主要是為了保證代碼在不同平臺(tái)間共享時(shí)不出現(xiàn)問題。

引用框架的根頭文件

上面提到過，每一個(gè)框架都會(huì)有一個(gè)和框架同名的頭文件，它包含了框架內(nèi)接口的所有引用，在使用框架的時(shí)候，應(yīng)該直接引用這個(gè)根頭文件，而不是其它子模塊的頭文件，即使是你只用到了其中的一小部分，編譯器會(huì)自動(dòng)完成優(yōu)化的。

//正確，引用根頭文件
#import <Foundation/Foundation.h>

//錯(cuò)誤，不要單獨(dú)引用框架內(nèi)的其它頭文件
#import <Foundation/NSArray.h>
#import <Foundation/NSString.h>

BOOL的使用

BOOL在Objective-C中被定義為signed char類型，這意味著一個(gè)BOOL類型的變量不僅僅可以表示YES(1)和NO(0)兩個(gè)值，所以永遠(yuǎn)不要將BOOL類型變量直接和YES比較：

//錯(cuò)誤，無法確定|great|的值是否是YES(1)，不要將BOOL值直接與YES比較
BOOL great = [foo isGreat];
if (great == YES)
  // ...be great!

//正確
BOOL great = [foo isGreat];
if (great)
  // ...be great!

同樣的，也不要將其它類型的值作為BOOL來返回，這種情況下，BOOL變量只會(huì)取值的最后一個(gè)字節(jié)來賦值，這樣很可能會(huì)取到0（NO）。但是，一些邏輯操作符比如&&,||,!的返回是可以直接賦給BOOL的：

//錯(cuò)誤，不要將其它類型轉(zhuǎn)化為BOOL返回
- (BOOL)isBold {
  return [self fontTraits] & NSFontBoldTrait;
}
- (BOOL)isValid {
  return [self stringValue];
}

//正確
- (BOOL)isBold {
  return ([self fontTraits] & NSFontBoldTrait) ? YES : NO;
}

//正確，邏輯操作符可以直接轉(zhuǎn)化為BOOL
- (BOOL)isValid {
  return [self stringValue] != nil;
}
- (BOOL)isEnabled {
  return [self isValid] && [self isBold];
}

另外BOOL類型可以和_Bool,bool相互轉(zhuǎn)化，但是不能和Boolean轉(zhuǎn)化。

使用ARC

除非想要兼容一些古董級(jí)的機(jī)器和操作系統(tǒng)，我們沒有理由放棄使用ARC。在最新版的Xcode(6.2)中，ARC是自動(dòng)打開的，所以直接使用就好了。

在init和dealloc中不要用存取方法訪問實(shí)例變量

當(dāng)init``dealloc方法被執(zhí)行時(shí)，類的運(yùn)行時(shí)環(huán)境不是處于正常狀態(tài)的，使用存取方法訪問變量可能會(huì)導(dǎo)致不可預(yù)料的結(jié)果，因此應(yīng)當(dāng)在這兩個(gè)方法內(nèi)直接訪問實(shí)例變量。

//正確，直接訪問實(shí)例變量
- (instancetype)init {
  self = [super init];
  if (self) {
    _bar = [[NSMutableString alloc] init];
  }
  return self;
}
- (void)dealloc {
  [_bar release];
  [super dealloc];
}

//錯(cuò)誤，不要通過存取方法訪問
- (instancetype)init {
  self = [super init];
  if (self) {
    self.bar = [NSMutableString string];
  }
  return self;
}
- (void)dealloc {
  self.bar = nil;
  [super dealloc];
}

按照定義的順序釋放資源

在類或者Controller的生命周期結(jié)束時(shí)，往往需要做一些掃尾工作，比如釋放資源，停止線程等，這些掃尾工作的釋放順序應(yīng)當(dāng)與它們的初始化或者定義的順序保持一致。這樣做是為了方便調(diào)試時(shí)尋找錯(cuò)誤，也能防止遺漏。

保證NSString在賦值時(shí)被復(fù)制

NSString非常常用，在它被傳遞或者賦值時(shí)應(yīng)當(dāng)保證是以復(fù)制（copy）的方式進(jìn)行的，這樣可以防止在不知情的情況下String的值被其它對(duì)象修改。

- (void)setFoo:(NSString *)aFoo {
  _foo = [aFoo copy];
}

使用NSNumber的語法糖

使用帶有@符號(hào)的語法糖來生成NSNumber對(duì)象能使代碼更簡潔：

NSNumber *fortyTwo = @42;
NSNumber *piOverTwo = @(M_PI / 2);
enum {
  kMyEnum = 2;
};
NSNumber *myEnum = @(kMyEnum);

nil檢查

因?yàn)樵贠bjective-C中向nil對(duì)象發(fā)送命令是不會(huì)拋出異常或者導(dǎo)致崩潰的，只是完全的“什么都不干”，所以，只在程序中使用nil來做邏輯上的檢查。

另外，不要使用諸如nil == Object或者Object == nil的形式來判斷。

//正確，直接判斷
if (!objc) {
    ...
}

//錯(cuò)誤，不要使用nil == Object的形式
if (nil == objc) {
    ...
}

屬性的線程安全

定義一個(gè)屬性時(shí)，編譯器會(huì)自動(dòng)生成線程安全的存取方法（Atomic），但這樣會(huì)大大降低性能，特別是對(duì)于那些需要頻繁存取的屬性來說，是極大的浪費(fèi)。所以如果定義的屬性不需要線程保護(hù)，記得手動(dòng)添加屬性關(guān)鍵字nonatomic來取消編譯器的優(yōu)化。

點(diǎn)分語法的使用

不要用點(diǎn)分語法來調(diào)用方法，只用來訪問屬性。這樣是為了防止代碼可讀性問題。

//正確，使用點(diǎn)分語法訪問屬性
NSString *oldName = myObject.name;
myObject.name = @"Alice";

//錯(cuò)誤，不要用點(diǎn)分語法調(diào)用方法
NSArray *array = [NSArray arrayWithObject:@"hello"];
NSUInteger numberOfItems = array.count;
array.release;

Delegate要使用弱引用

一個(gè)類的Delegate對(duì)象通常還引用著類本身，這樣很容易造成引用循環(huán)的問題，所以類的Delegate屬性要設(shè)置為弱引用。

/** delegate */
@property (nonatomic, weak) id <IPCConnectHandlerDelegate> delegate;

轉(zhuǎn)載自: BABaseProject

iOS 注釋方法大全 代碼塊加快捷鍵自定義注釋

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 轉(zhuǎn)載自：『博愛』 Objective-C-Coding-Guidelines-In-Chinese 概要 Obje...
    王_堯閱讀 1,260評(píng)論 0贊 2
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具（例如配置管理，服務(wù)發(fā)現(xiàn)，斷路器，智...
    卡卡羅2017閱讀 136,506評(píng)論 19贊 139
  • iOS編程規(guī)范0規(guī)范 0.1前言 為??高產(chǎn)品代碼質(zhì)量,指導(dǎo)廣大軟件開發(fā)人員編寫出簡潔、可維護(hù)、可靠、可 測(cè)試、高效...
    iOS行者閱讀 4,589評(píng)論 21贊 35
  • 代碼格式 使用空格而不是制表符 Tab 不要在工程里使用 Tab 鍵，使用空格來進(jìn)行縮進(jìn)。在 Xcode > Pr...
    small_Sun閱讀 1,458評(píng)論 1贊 3
  • 推薦文章：禪與 Objective-C 編程藝 前言 為??高產(chǎn)品代碼質(zhì)量,指導(dǎo)廣大軟件開發(fā)人員編寫出簡潔、可維護(hù)、...
    WolfTin閱讀 2,938評(píng)論 0贊 1

友情鏈接更多精彩內(nèi)容