天天看點

IOS命名

NS開頭的名稱不要出現。 NS系統名稱開頭。

命名縮寫隻用于通用專業術語,如

URL

,不可自創命名縮寫,如

Ctr

Msg

。命名甯可長一些,也不要難于了解。

是否在看别人代碼時各種縮寫而不知其是以然?簡短的名字确實比較好,但不可濫用縮寫導緻失去可讀性。

過程化

動作發生之前用

Will

,發生之後用

Did

,詢問是否發生用

Should

每個處理都是有一定過程的,這個處理往往會産生一些通知和回調,好的命名必須要明确目前過程中的步驟。命名這些通知和回調時最好提供發生前後兩個版本,如果發生前要回調确認,請用

Should

命名該回調,并傳回一個

BOOL

值。

名字空間

各種全局作用範圍的函數,常量,類,枚舉,結構等命名必須加命名字首。

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

  • 類型(類、枚舉、結構)命名前要加相關子產品字首。
    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

來定義常量。

轉載于:https://www.cnblogs.com/wcLT/p/4735665.html