ios編碼規范

Object-C 開發代碼規范
概要
Object-C是一門面向對象的動態編程語言，主要用于編寫IOS和MAC應用程序。關于Object-C蘋果已經有很好的總結：
https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/CodingGuidelines/CodingGuidelines.html

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

代碼格式
每一行的最大長度
同樣的，在Xcode > Preferences > Text Editing > Page guide at column中將最大行長設置為80，過長的一行代碼將會導致可讀性問題。
函數的書寫
一個典型的Object-C函數應該是這樣的：

  • (void)createMethodParam:(NSString*)str type:(NSInteger)type{
    ……
    }

在-和(void)之間應該有一個空格，第一個大括號{的位置在函數所在行的末尾，同樣應該有一個空格。

如果一個函數有特別多的參數或者名稱很長，應該將其按照:來對齊分行顯示：

  • (void)initWithModel:(Model *)model
    param1:(NSString *) param1
    param2:(NSString *) param2
    param3:(NSString *) param3
    param4:(NSString *) param4;
    在分行時，如果第一段名稱過短，后續名稱可以以Tab的長度為單位進行縮進：
  • (void)initWithModel:(Model *)model
    param1:(NSString *) param1
    paramString2:(NSString *) param2
    param4:(NSString *) param4;
    函數發送
    函數發送的格式和書寫格式差不多，可以按照函數的長短來選擇寫在一行或者是分成多行：
    //寫在一行
    [myObject doFooWith:arg1 name:arg2 error:arg3];

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

//第一段名稱過短的話后續可以進行縮進
[myObj short:arg1
longKeyword:arg2
evenLongerKeyword:arg3
error:arg4];
@public和@private標記符
@public和@private標記符應該以一個空格來進行縮進：
@interface MyClass : NSObject {
@public
...
@private
...
}
@end

協議（Protocols）
在書寫協議的時候注意用<>括起來的協議和類型名之間是沒有空格的，比如DemoClass()<DemoClassDelegate>,這個規則適用所有書寫協議的地方，包括函數聲明、類生命、實例變量等等：
@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], [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
};

命名規范
基本原則
清晰
命名應該盡可能的清晰和簡潔，但在Object-C中，清晰比簡潔更重要。由于Xcode強大的自動補全功能，我們不必擔心名稱過長的問題。

//清晰
insertObject:atIndex:

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

//清晰
removeObjectAtIndex:

//不清晰，remove的對象類型沒有說明，參數的作用沒有說明
remove:

不要使用單詞的簡寫，拼寫出完整的單詞：
//清晰
destinationSelection
setBackgroundColor:

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

然而，有部分單詞簡寫在Object-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 :(id)anObject :(BOOL)flag;

//正確

  • (id)viewWithTag:(NSInteger)aTag;

//錯誤，關鍵詞的作用不清晰

  • (id)taggedView:(int)aTag;

命名委托（Delegate）

當特定的事件發生時，對象會觸發它注冊的委托方法。委托是Objective-C中常用的傳遞消息的方式。委托有它固定的命名范式。

一個委托方法的第一個參數是觸發它的對象，第一個關鍵詞是觸發對象的類名，除非委托方法只有一個名為sender的參數：

//第一個關鍵詞為觸發委托的類名

  • (BOOL)tableView:(NSTableView *)tableView shouldSelectRow:(int)row;
  • (BOOL)application:(NSApplication *)sender openFile:(NSString *)filename;

//當只有一個參數時可以省略類名

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

命名屬性和實例變量（Properties&Instance Variables）

屬性和對象的存取方法相關聯，屬性的第一個字母小寫，后續單詞首字母大寫，不必添加前綴。屬性按功能命名成名詞或者動詞：
//名詞屬性
@property (strong) NSString *title;

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

屬性也可以命名成形容詞，這時候通常會指定一個帶有is前綴的get方法來提高可讀性：
@property (assign, getter=isEditable) BOOL editable;

命名常量（Constants）

如果要定義一組相關的常量，盡量使用枚舉類型（enumerations），枚舉類型的命名規則和函數的命名規則相同。 建議使用 NS_ENUM 和 NS_OPTIONS 宏來定義枚舉類型，參見官方的 https://developer.apple.com/library/content/releasenotes/ObjectiveC/ModernizationObjC/AdoptingModernObjective-C/AdoptingModernObjective-C.html 一文：
//定義一個枚舉
typedef NS_ENUM(NSInteger, NSMatrixMode) {
NSRadioModeMatrix,
NSHighlightModeMatrix,
NSListModeMatrix,
NSTrackModeMatrix
};
使用const定義浮點型或者單個的整數型常量，如果要定義一組相關的整數常量，應該優先使用枚舉。常量的命名規范和函數相同：
const float NSLightGray;

不要使用#define宏來定義常量，如果是整型常量，盡量使用枚舉，浮點型常量，使用const定義。#define通常用來給編譯器決定是否編譯某塊代碼，比如常用的： #ifdef DEBUG
注意到一般由編譯器定義的宏會在前后都有一個__，比如MACH。
注釋

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

文件注釋

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

文件所在模塊
作者信息
歷史版本信息
版權信息
文件包含的內容，作用
一段良好文件注釋的例子：
文件注釋的格式通常不作要求，能清晰易讀就可以了，但在整個工程中風格要統一。

代碼注釋

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

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

最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發布，文章內容僅代表作者本人觀點，簡書系信息發布平臺，僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • 面試被問到公司編碼規范問題，感覺有很多東西，但是不知道該怎么說出來，今天突然找到 李明杰 老師的一份編碼規范。重新...
    Dombo_Y閱讀 994評論 1贊 2
  • 一．代碼命名 一般性原則 最好是既清晰又簡短，但不要為簡短而喪失清晰性。 例如：removeObject:AtIn...
    睡不完懶覺閱讀 1,799評論 0贊 16
  • 命名 Bundle id命名： 規則：采用反域名命名規則，全部使用小寫字母。一級包名為com，二級包名根據應用進行...
    Tippi閱讀 1,692評論 0贊 2
  • 以下所有純屬個人習慣，不喜勿噴 語言：應該使用美國英語命名 如 UIColor *myColor = [UICol...
    夾娃娃達人閱讀 333評論 0贊 0
  • 一瞬間回來的日子 讓愛情又一次停頓 一瞬間回歸的淚在夜光中閃爍 一瞬間深情的告白觸碰冷漠的臉龐 這個夜晚漆黑卻透著...
    當代詩人云煙閱讀 289評論 1贊 10