Objective-C命名編寫規範

There are only two hard things in Computer Science: cache invalidation and naming things.
在計算機科學中只有兩件難事:緩存失效和命名。 緩存

— Phil Karltonapp

 

計算機語言是人和計算機之間通信的媒介。好的代碼應該是就像人對計算機說話那樣,天然而優雅。命名看上去是一件很簡單的事,而每每越是簡單的事越難 作好,不然大師們也不會把命名當作是計算機界的難題了。如何把Objective-C這門計算機語言以優雅的方式「說」出,仍是比較考驗工程師對它的理解 深度的。在蘋果的SDK中有大量的API,咱們能夠從這些API中體會到一些命名的藝術。ide

減小縮寫

命名縮寫只用於通用專業術語,如URL,不可自創命名縮寫,如CtrMsg。命名寧肯長一些,也不要難於理解。函數

是否在看別人代碼時各類縮寫而不知其因此然?簡短的名字確實比較好,但不可濫用縮寫致使失去可讀性。url

過程化

動做發生以前用Will,發生以後用Did,詢問是否發生用Shouldspa

每一個處理都是有必定過程的,這個處理每每會產生一些通知和回調,好的命名必需要明確當前過程當中的步驟。命名這些通知和回調時最好提供發生先後兩個版本,若是發生前要回調確認,請用Should命名該回調,並返回一個BOOL值。code

名字空間

各類全局做用範圍的函數,常量,類,枚舉,結構等命名必須加命名前綴。orm

Objective-C中沒有C++那樣的名字空間概念,也沒有Java包名的概念,隨着工程代碼的增長,不免會出現名字衝突,所以全局做用範圍的名字必須惟一。比較經典的作法就是加命名前綴。大多數人認爲命名前綴只是在類的前面加幾個大寫字母,其實不只僅如此。對象

  • 類型(類、枚舉、結構)命名前要加相關模塊前綴。ip

    UIView NSString CGRect
  • 常量命名要加相關類型名前綴。

    UIApplicationDidFinishLaunchingNotification CGRectZero
  • 函數命名要加相關類型名前綴。

    CGRectMake CGPointMake
  • 枚舉類型命名要加相關類名前綴,而且枚舉值命名要加枚舉類型前綴。

    typedef NS_ENUM(NSInteger, UIViewAnimationTransition) { UIViewAnimationTransitionNone, UIViewAnimationTransitionFlipFromLeft, UIViewAnimationTransitionFlipFromRight, UIViewAnimationTransitionCurlUp, UIViewAnimationTransitionCurlDown, };

作到以上幾點幾乎能夠作到名字不會衝突。

參數提示

方法命名時,每一個參數前要加參數的名稱提示。

- (id)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil - (void)performSegueWithIdentifier:(NSString *)identifier sender:(id)sender

對象命名

給一個帶修飾的對象命名時要採用修飾+類型的方式,而不是先指定其類型。

不少人喜歡把對象的類型放在對象的命名前面,從而來標識一個對象是什麼類型,這很不符合Objective-C語言的特色,容易引發歧義,好比一個UILabel對象:

titleLabel //表示標題的label,是UIlabel對象 labelTitle //label的標題?彷佛是一個NSString? confirmButton //確認按鈕 buttonConfirm //不天然的命名,看上去像是按鈕點擊動做。

方法命名符合語法

大部分方法能夠分紅下面兩類,而這兩類每每被亂用。它們是:

  • 要什麼
  • 作什麼

「要什麼」表示取得某個對象,要以名詞做爲方法的開頭;「作什麼」表示執行某種操做,要以動詞做爲方法開頭。看看下面這個命名方式:

- (XXItem *)itemNamed:(NSString *)name //Good. 意思清晰 - (XXItem *)findItemWithName:(NSString *)name //更像是一種操做,而不是返回一個對象。

findItemWithName這個命名錶示一種操做,而無需返回對象,好比它能夠用於設置類的內部成員,好比:

- (void)findItemWithName:(NSString *)name{ ... self.foundItem = xxx; ... }

get

「要什麼」每每被胡亂命名爲get開頭的方法。首先get是一個動詞,因此它仍是「作什麼」或者說「作的是要什麼」。那麼get方法不要用於返回對象,但它可用於參數中返回。

- (XXItem *)getItemAtIndex:(NSUInteger)index //Bad!! 不規範的命名 - (XXItem *)itemAtIndex:(NSUInteger)index //Good, 命名清晰 - (void)getItem:(XXItem **)outItem atIndex:(NSUInteger)index //比較符合規範,但第二種更好。

可知性

回調時被調用者要知道其調用者

能夠在回調方法中第一個參數中加上調用者:

- (BOOL)application:(UIApplication *)application willFinishLaunchingWithOptions:(NSDictionary *)launchOptions - (void)buttonTapped:(UIButton*)sender

常量仍是宏

全局常量不可以使用宏定義

咱們常常看到一些用宏定義的通知,關鍵字等。其實這麼作是很是危險的,由於宏極可能被重定義,並且引用不一樣的文件可能會致使宏的不一樣,因此儘可能使用const來定義常量。

一些思考

命名的好壞在開發中每每也不怎麼重視,畢竟差的命名也不會影響程序邏輯。

可是很差的命名在大項目中帶來的隱形維護成本是至關高的,這些在項目開始時 可能還很難察覺,然後來會陷入前仆後繼的維護困境中。

咱們每每很是重視項目邏輯的複雜性,卻不能好好的把「簡單」的命名作好。

其實,若是簡單的東西都作很差,那麼作出再複雜的東西那也是垃圾。

相關文章
相關標籤/搜索