命名縮寫只用于通用專業術語,如URL
,不可自創命名縮寫,如Ctr
、Msg
。命名寧可長一些,也不要難于理解。
動作發生之前用Will
,發生之后用Did
,詢問是否發生用Should
。
每個處理都是有一定過程的,這個處理往往會產生一些通知和回調,好的命名必須要明確當前過程中的步驟。命名這些通知和回調時最好提供發生前后兩個版本,如果發生前要回調確認,請用Should
命名該回調,并返回一個BOOL
值。
各種全局作用范圍的函數,常量,類,枚舉,結構等命名必須加命名前綴。
Objective-C中沒有C++那樣的名字空間概念,也沒有java包名的概念,隨著工程代碼的增加,難免會出現名字沖突,因此全局作用范圍的名字必須唯一。比較經典的做法就是加命名前綴。大多數人認為命名前綴只是在類的前面加幾個大寫字母,其實不僅僅如此。
類型(類、枚舉、結構)命名前要加相關模塊前綴。
UIViewNSStringCGRect
常量命名要加相關類型名前綴。
UIapplicationDidFinishLaunchingNotificationCGRectZero
函數命名要加相關類型名前綴。
CGRectMakeCGPointMake
枚舉類型命名要加相關類名前綴,并且枚舉值命名要加枚舉類型前綴。
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方法不要用于返回對象,但它可用于參數中返回。
- (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
來定義常量。
新聞熱點
疑難解答