iOS擴展——Objective-C開發編程規範

来源:https://www.cnblogs.com/mukekeheart/archive/2018/01/18/8310592.html
-Advertisement-
Play Games

本文主要轉載自：Objective-C-Coding-Guidelines-In-Chinese Objective-C編碼規範，內容來自蘋果、谷歌的文檔翻譯，自己的編碼經驗和對其它資料的總結。 一 概要 Objective-C是一門面向對象的動態編程語言，主要用於編寫iOS和Mac應用程式。關於O ...


　　最近準備開始系統學習一個完整項目的開發流程和思路，在此之前，我們需要對iOS的開發變成規範進行更系統和詳盡的學習，隨意對編程規範進行了整理和學習。本文內容主要轉載自：Objective-C-Coding-Guidelines-In-Chinese

Objective-C編碼規範，內容來自蘋果、谷歌的文檔翻譯，自己的編碼經驗和對其它資料的總結。

一 概要

Objective-C是一門面向對象的動態編程語言，主要用於編寫iOS和Mac應用程式。關於Objective-C的編碼規範，蘋果和谷歌都已經有很好的總結：

本文主要整合了對上述文檔的翻譯、作者自己的編程經驗和其他的相關資料，為公司總結出一份通用的編碼規範。

二 代碼格式

2.1 使用空格而不是製表符Tab

　　不要在工程里使用Tab鍵，使用空格來進行縮進。在Xcode > Preferences > Text Editing將Tab和自動縮進都設置為4個空格。（Google的標準是使用兩個空格來縮進，但這裡還是推薦使用Xcode預設的設置。）

2.2 每一行的最大長度

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

2.3 函數的書寫

　　一個典型的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 {
    ...
}

2.4 函數調用

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

//寫在一行
[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];

2.5 @public和@private標記符

　　@public和@private標記符應該以一個空格來進行縮進：

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

2.6 協議（Protocols）

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

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

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

2.7 閉包（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) {
        // ...
    }];

2.8 數據結構的語法糖

　　應該使用可讀性更好的語法糖來構造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",
};

三 命名規範

3.1 基本原則

3.1.1 清晰

　　命名應該儘可能的清晰和簡潔，但在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

3.1.2 一致性

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

3.2 使用首碼

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

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

  • 可以在為類、協議、函數、常量以及typedef巨集命名的時候使用首碼，但註意不要為成員變數或者方法使用首碼，因為他們本身就包含在類的命名空間內。

  • 命名首碼的時候不要和蘋果SDK框架衝突。

3.3 命名類和協議（Class&Protocol）

  • 類名以大寫字母開頭，應該包含一個名詞來表示它代表的對象類型，同時可以加上必要的首碼，比如NSString, NSDate, NSScanner, NSApplication等等。
  • 而協議名稱應該清晰地表示它所執行的行為，而且要和類名區別開來，所以通常使用ing詞尾來命名一個協議，比如NSCopying,NSLocking。

　　有些協議本身包含了很多不相關的功能，主要用來為某一特定類服務，這時候可以直接用類名來命名這個協議，比如NSObject協議，它包含了id對象在生存周期內的一系列方法。

3.4 命名頭文件（Headers）

源碼的頭文件名應該清晰地暗示它的功能和包含的內容：

  • 如果頭文件內只定義了單個類或者協議，直接用類名或者協議名來命名頭文件，比如NSLocale.h定義了NSLocale類。

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

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

  • Framework中有時候會實現在別的框架中類的類別擴展，這樣的文件通常使用被擴展的框架名+Additions的方式來命名，比如NSBundleAdditions.h。

3.5 命名方法（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 :(id)anObject :(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

3.6 存取方法（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;

3.7 命名委托（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;

3.8 集合操作類方法（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;

3.9 命名函數（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)

3.10 命名屬性和實例變數（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方法以外的地方直接訪問實例變數，但很多人認為直接訪問會讓代碼更加清晰可讀，只在需要計算或者執行操作的時候才使用存取方法訪問，我就是這種習慣，所以這裡不作要求。

3.11 命名常量（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__*。

3.12 命名通知（Notifications）

通知常用於在模塊間傳遞消息，所以通知要儘可能地表示出發生的事件，通知的命名範式是：

[觸發通知的類名] + [Did | Will] + [動作] + Notification

//慄子：
NSApplicationDidBecomeActiveNotification
NSWindowDidMiniaturizeNotification
NSTextViewDidChangeSelectionNotification
NSColorPanelColorDidChangeNotification

四 註釋

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

4.1 文件註釋

每一個文件都必須寫文件註釋，文件註釋通常包含

  • 文件所在模塊
  • 作者信息
  • 歷史版本信息
  • 版權信息
  • 文件包含的內容，作用

一段良好文件註釋的慄子：

/*******************************************************************************
    Copyright (C), 2011-2013, Andrew Min Chang

    File name:     AMCCommonLib.h
    Author:        Andrew Chang (Zhang Min) 
    E-mail:        [email protected]
    
    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. 
        
********************************************************************************/

 文件註釋的格式通常不作要求，能清晰易讀就可以了，但在整個工程中風格要統一。

4.2 代碼註釋

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

方法、函數、類、協議、類別的定義都需要註釋，推薦採用Apple的標準註釋風格，好處是可以在引用的地方alt+點擊自動彈出註釋，非常方便。

有很多可以自動生成註釋格式的插件，推薦使用VVDocumenter：

Screenshot

一些良好的註釋：

/**
 *  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編程風格和註意點。

5.1 不要使用new方法

　　儘管很多時候能用new代替alloc init方法，但這可能會導致調試記憶體時出現不可預料的問題。Cocoa的規範就是使用alloc init方法，使用new會讓一些讀者困惑。

5.2 Public API要儘量簡潔

　　共有介面要設計的簡潔，滿足核心的功能需求就可以了。不要設計很少會被用到，但是參數極其複雜的API。如果要定義複雜的方法，使用類別或者類擴展。

5.3 #import和#include

#import是Cocoa中常用的引用頭文件的方式，它能自動防止重覆引用文件，什麼時候使用#import，什麼時候使用#include呢？

  • 當引用的是一個Objective-C或者Objective-C++的頭文件時，使用#import
  • 當引用的是一個C或者C++的頭文件時，使用#include，這時必須要保證被引用的文件提供了保護域（#define guard）。

慄子：

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

 為什麼不全部使用#import呢？主要是為了保證代碼在不同平臺間共用時不出現問題。

5.4 引用框架的根頭文件

　　上面提到過，每一個框架都會有一個和框架同名的頭文件，它包含了框架內介面的所有引用，在使用框架的時候，應該直接引用這個根頭文件，而不是其它子模塊的頭文件，即使是你只用到了其中的一小部分，編譯器會自動完成優化的。

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

//錯誤，不要單獨引用框架內的其它頭文件
#import <Foundation/NSArray.h>
#import <Foundation/NSString.h>

5.5 BOOL的使用

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

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

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

　　同樣的，也不要將其它類型的值作為BOOL來返回，這種情況下，BOOL變數只會取值的最後一個位元組來賦值，這樣很可能會取到0（NO）。但是，一些邏輯操作符比如&&,||,!的返回是可以直接賦給BOOL的：

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

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

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

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

5.6 使用ARC

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

5.7 在init和dealloc中不要用存取方法訪問實例變數

　　當init``dealloc方法被執行時，類的運行時環境不是處於正常狀態的，使用存取方法訪問變數可能會導致不可預料的結果，因此應當在這兩個方法內直接訪問實例變數。

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

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

5.8 按照定義的順序釋放資源

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

5.9 保證NSString在賦值時被覆制

　　NSString非常常用，在它被傳遞或者賦值時應當保證是以複製（copy）的方式進行的，這樣可以防止在不知情的情況下String的值被其它對象修改。

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

5.10 使用NSNumber的語法糖

使用帶有@符號的語法糖來生成NSNumber對象能使代碼更簡潔：

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

5.11 nil檢查

因為在Objective-C中向nil對象發送命令是不會拋出異常或者導致崩潰的，只是完全的“什麼都不幹”，所以，只在程式中使用nil來做邏輯上的檢查。

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

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

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

5.12 屬性的線程安全

　　定義一個屬性時，編譯器會自動生成線程安全的存取方法（Atomic），但這樣會大大降低性能，特別是對於那些需要頻繁存取的屬性來說，是極大的浪費。所以如果定義的屬性不需要線程保護，記得手動添加屬性關鍵字nonatomic來取消編譯器的優化。

5.13 點分語法的使用

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

//正確，使用點分語法訪問屬性
NSString *oldName = myObject.name;
myObject.name = @"Alice
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • mysq的蠕蟲複製
    INSERT into user_info(version,create_user_count,create_pc_count) select version,create_user_count,create_pc_count from user_info;mysql蠕蟲複製，大量數據 。 ...
  • PowerDesigner Constraint name uniqueness 錯誤
    使用PowerDesigner生成資料庫腳本時報 Constraint name uniqueness 錯誤： 雙擊每行錯誤，發現外鍵引用的名字有重覆的： 慣性去網上找解決辦法，找到的主要是兩個方法： 1.使用Automatic Correction 右鍵錯誤行，菜單中選擇Automatic Cor ...
  • [20180118]tstats的問題.txt
    [20180118]tstats的問題.txt--//關於使用tstats收集處理統計信息，可以看鏈接http://blog.itpub.net/267265/viewspace-1987839/TSTATS in a Nutshell P97The removal of time-sensitiv ...
  • powerdesigner 將表中name列值複製到comment列 (保留原有comment)
    /** * PowerDesigner裡面將表中name列值複製到comment列 * @see -----------------------------------------------------------------------------------------------------... ...
  • Transaction ACID （轉載）
    Transaction Transaction 原文出處： 黃勇 Transaction 也就是所謂的事務了，通俗理解就是一件事情。從小，父母就教育我們，做事情要有始有終，不能半途而廢。�0�2事務也是這樣，不能做一般就不做了，要麼做完，要麼就不做。也就是說，事務必須是一個不可分割的整體，就像我們在 ...
  • ReactiveCocoa(上)
    ReactiveCocoa常見類 1. RAC中最核心的類RACSiganl： RACSiganl:信號類,一般表示將來有數據傳遞，只要有數據改變，信號內部接收到數據，就會馬上發出數據 解析： 信號類(RACSiganl)，只是表示當數據改變時，信號內部會發出數據，它本身不具備發送信號的能力，而是交 ...
  • SSM到Spring Boot 從零開發校園商鋪平臺
    後端開發:1、高級java軟體架構師實戰培訓視頻教程2、大型SpringMVC，Mybatis，Redis，Solr，Nginx，SSM分散式電商項目視頻教程3、Spark Streaming實時流處理項目實戰4、Java校招面試 Google面試官親授5、Java開發企業級許可權管理系統6、Java ...
  • Android命令之-------ADB命令大全
    1.顯示當前運行的全部模擬器： adb devices2.啟動ADB adb start-server3.停止ADB adb kill-server4.安裝應用程式： adb install -r [apk文件]-l #鎖定該程式-r #重新安裝該程式，保存數據-s #安裝在SD卡內，而不是設備內部 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類