google objective-c coding style(2)命名

標籤：

對於易維護的代碼而言，命名規則非常重要。Objective-C 的方法名往往十分長，但代碼塊讀起來就像散文一樣，不需要太多的代碼注釋。

當編寫純粹的 Objective-C 代碼時，我們基本遵守標準的 Objective-C naming rules，這些命名規則可能與 C++ 風格指南中的大相徑庭。例如，Google 的 C++ 風格指南中推薦使用底線分隔的單詞作為變數名，而(蘋果的)風格指南則使用駝峰命名法，這在 Objective-C 社區中非常普遍。

任何的類、類別、方法以及變數的名字中都使用全大寫的 首字母縮寫。這遵守了蘋果的標準命名方式，如 URL、TIFF 以及 EXIF。

當編寫 Objective-C++ 代碼時，事情就不這麼簡單了。許多項目需要實現跨平台的 C++ API，並混合一些 Objective-C、Cocoa 代碼，或者直接以 C++ 為後端，前端用本地 Cocoa 代碼。這就導致了兩種命名方式直接不統一。

我們的解決方案是：編碼風格取決於方法/函數以哪種語言實現。如果在一個 @implementation 語句中，就使用 Objective-C 的風格。如果實現一個 C++ 的類，就使用 C++ 的風格。這樣避免了一個函數裡面執行個體變數和局部變數命名規則混亂，嚴重影響可讀性。

檔案名稱

Tip

檔案名稱須反映出其實現了什麼類 – 包括大小寫。遵循你所參與項目的約定。

檔案的副檔名應該如下：

.h	C/C++/Objective-C 的標頭檔
.m	Ojbective-C 實現檔案
.mm	Ojbective-C++ 的實現檔案
.cc	純 C++ 的實現檔案
.c	純 C 的實現檔案

類別的檔案名稱應該包含被擴充的類名，如：GTMNSString+Utils.h 或``GTMNSTextView+Autocomplete.h``。

Objective-C++

Tip

原始碼檔案內，Ojbective-C++ 代碼遵循你正在實現的函數/方法的風格。

為了最小化 Cocoa/Objective-C 與 C++ 之間命名風格的衝突，根據待實現的函數/方法選擇編碼風格。實現 @implementation 語句塊時，使用 Objective-C 的命名規則；如果實現一個 C++ 的類，就使用 C++ 命名規則。

// file: cross_platform_header.hclass CrossPlatformAPI { public:  ...  int DoSomethingPlatformSpecific();  // impl on each platform private:  int an_instance_var_;};// file: mac_implementation.mm#include "cross_platform_header.h"// A typical Objective-C class, using Objective-C naming.@interface MyDelegate : NSObject { @private  int instanceVar_;  CrossPlatformAPI* backEndObject_;}- (void)respondToSomething:(id)something;@end@implementation MyDelegate- (void)respondToSomething:(id)something {  // bridge from Cocoa through our C++ backend  instanceVar_ = backEndObject->DoSomethingPlatformSpecific();  NSString* tempString = [NSString stringWithInt:instanceVar_];  NSLog(@"%@", tempString);}@end// The platform-specific implementation of the C++ class, using// C++ naming.int CrossPlatformAPI::DoSomethingPlatformSpecific() {  NSString* temp_string = [NSString stringWithInt:an_instance_var_];  NSLog(@"%@", temp_string);  return [temp_string intValue];}

類名

Tip

類名（以及類別、協議名）應首字母大寫，並以駝峰格式分割單詞。

應用程式層 的代碼，應該盡量避免不必要的首碼。為每個類都添加相同的首碼無助於可讀性。當編寫的代碼期望在不同應用程式間複用時，應使用首碼（如：GTMSendMessage）。

類別名

Tip

類別名應該有兩三個字母的首碼以表示類別是項目的一部分或者該類別是通用的。類別名應該包含它所擴充的類的名字。

比如我們要基於 NSString 建立一個用於解析的類別，我們將把類別放在一個名為 GTMNSString+Parsing.h 的檔案中。類別本身命名為 GTMStringParsingAdditions （是的，我們知道類別名和檔案名稱不一樣，但是這個檔案中可能存在多個不同的與解析有關類別）。類別中的方法應該以 gtm_myCategoryMethodOnAString: 為首碼以避免命名衝突，因為 Objective-C 只有一個名字空間。如果代碼不會分享出去，也不會運行在不同的地址空間中，方法名字就不那麼重要了。

類名與包含類別名的括弧之間，應該以一個空格分隔。

Objective-C 方法名

Tip

方法名應該以小寫字母開頭，並混合駝峰格式。每個具名參數也應該以小寫字母開頭。

方法名應盡量讀起來就像句子，這表示你應該選擇與方法名連在一起讀起來通順的參數名。（例如，convertPoint:fromRect: 或 replaceCharactersInRange:withString:）。詳情參見 Apple’s Guide to Naming Methods。

訪問器方法應該與他們 要擷取的 成員變數的名字一樣，但不應該以get作為首碼。例如：

- (id)getDelegate;  // AVOID- (id)delegate;     // GOOD

這僅限於 Objective-C 的方法名。C++ 的方法與函數的命名規則應該遵從 C++ 風格指南中的規則。

變數名

Tip

變數名應該以小寫字母開頭，並使用駝峰格式。類的成員變數應該以底線作為尾碼。例如：myLocalVariable、myInstanceVariable_。如果不能使用 Objective-C 2.0 的 @property，使用 KVO/KVC 綁定的成員變數可以以一個底線作為首碼。

普通變數名

對於靜態屬性（int 或指標），不要使用匈牙利命名法。盡量為變數起一個描述性的名字。不要擔心浪費列寬，因為讓新的代碼閱讀者立即理解你的代碼更重要。例如：

• 錯誤的命名：

  int w;int nerr;int nCompConns;tix = [[NSMutableArray alloc] init];obj = [someObject object];p = [network port];

• 正確的命名：

  int numErrors;int numCompletedConnections;tickets = [[NSMutableArray alloc] init];userInfo = [someObject object];port = [network port];

執行個體變數

執行個體變數應該混合大小寫，並以底線作為尾碼，如 usernameTextField_。然而，如果不能使用 Objective-C 2.0（作業系統版本的限制），並且使用了 KVO/KVC 綁定成員變數時，我們允許例外（譯者註： KVO=Key Value Observing，KVC=Key Value Coding）。這種情況下，可以以一個底線作為成員變數名字的首碼，這是蘋果所接受的鍵/值命名慣例。如果可以使用 Objective-C 2.0，@property 以及 @synthesize 提供了遵從這一命名規則的解決方案。

常量

常量名（如宏定義、枚舉、靜態局部變數等）應該以小寫字母 k 開頭，使用駝峰格式分隔單詞，如：kInvalidHandle，kWritePerm。

google objective-c coding style(2)命名