減少縮寫
命名縮寫只用于通用專業(yè)術(shù)語,如 URL歉甚,不可自創(chuàng)命名縮寫万细,如 Ctr、Msg纸泄。命名寧可長一些赖钞,也不要難于理解。
是否在看別人代碼時各種縮寫而不知其所以然聘裁?簡短的名字確實比較好仁烹,但不可濫用縮寫導(dǎo)致失去可讀性。
過程化
動作發(fā)生之前用 Will咧虎,發(fā)生之后用 Did卓缰,詢問是否發(fā)生用 Should。
每個處理都是有一定過程的砰诵,這個處理往往會產(chǎn)生一些通知和回調(diào)征唬,好的命名必須要明確當前過程中的步驟。命名這些通知和回調(diào)時最好提供發(fā)生前后兩個版本茁彭,如果發(fā)生前要回調(diào)確認总寒,請用 Should 命名該回調(diào),并返回一個 BOOL 值理肺。
名字空間
各種全局作用范圍的函數(shù)摄闸,常量,類妹萨,枚舉年枕,結(jié)構(gòu)等命名必須加命名前綴。
Objective-C中沒有C++那樣的名字空間概念乎完,也沒有Java包名的概念熏兄,隨著工程代碼的增加,難免會出現(xiàn)名字沖突树姨,因此全局作用范圍的名字必須唯一摩桶。比較經(jīng)典的做法就是加命名前綴。大多數(shù)人認為命名前綴只是在類的前面加幾個大寫字母帽揪,其實不僅僅如此硝清。
?類型(類、枚舉转晰、結(jié)構(gòu))命名前要加相關(guān)模塊前綴芦拿。
UIView
NSString
CGRect
?常量命名要加相關(guān)類型名前綴砾肺。
UIApplicationDidFinishLaunchingNotification
CGRectZero
?函數(shù)命名要加相關(guān)類型名前綴。
CGRectMake
CGPointMake
?枚舉類型命名要加相關(guān)類名前綴防嗡,并且枚舉值命名要加枚舉類型前綴变汪。
typedef NS_ENUM(NSInteger, UIViewAnimationTransition) {
UIViewAnimationTransitionNone,
UIViewAnimationTransitionFlipFromLeft,
UIViewAnimationTransitionFlipFromRight,
UIViewAnimationTransitionCurlUp,
UIViewAnimationTransitionCurlDown,
};
做到以上幾點幾乎可以做到名字不會沖突。
參數(shù)提示
方法命名時蚁趁,每個參數(shù)前要加參數(shù)的名稱提示裙盾。
- (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 //不自然的命名,看上去像是按鈕點擊動作染乌。
方法命名符合語法
大部分方法可以分成下面兩類山孔,而這兩類往往被亂用。它們是:
?要什么
?做什么
“要什么”表示取得某個對象荷憋,要以名詞作為方法的開頭台颠;“做什么”表示執(zhí)行某種操作,要以動詞作為方法開頭勒庄〈埃看看下面這個命名方式:
- (XXItem *)itemNamed:(NSString *)name //Good. 意思清晰
- (XXItem *)findItemWithName:(NSString *)name //更像是一種操作,而不是返回一個對象实蔽。
findItemWithName 這個命名表示一種操作荡碾,而無需返回對象,比如它可以用于設(shè)置類的內(nèi)部成員盐须,比如:
- (void)findItemWithName:(NSString *)name{
...
self.foundItem = xxx;
...
}
get
“要什么”往往被胡亂命名為get開頭的方法玩荠。首先get是一個動詞漆腌,所以它還是“做什么”或者說“做的是要什么”贼邓。那么get方法不要用于返回對象,但它可用于參數(shù)中返回闷尿。
- (XXItem *)getItemAtIndex:(NSUInteger)index //Bad!! 不規(guī)范的命名
- (XXItem *)itemAtIndex:(NSUInteger)index //Good, 命名清晰
- (void)getItem:(XXItem **)outItem atIndex:(NSUInteger)index //比較符合規(guī)范塑径,但第二種更好。
可知性
回調(diào)時被調(diào)用者要知道其調(diào)用者
可以在回調(diào)方法中第一個參數(shù)中加上調(diào)用者:
- (BOOL)application:(UIApplication *)application willFinishLaunchingWithOptions:(NSDictionary *)launchOptions
- (void)buttonTapped:(UIButton*)sender
常量還是宏
全局常量不可使用宏定義
我們經(jīng)程罹撸看到一些用宏定義的通知统舀,關(guān)鍵字等匆骗。其實這么做是非常危險的,因為宏很可能被重定義誉简,而且引用不同的文件可能會導(dǎo)致宏的不同碉就,所以盡量使用const來定義常量。