對于可維護的代碼,命名規(guī)則非常重要。 在iOS開發(fā)中Objective-C的方法名往往十分長,但代碼塊讀起來就像散文一樣,不需要太多的注釋修飾。
1. 文件名
文件的擴展名應該如下:
● .h, C/C++/Objective-C的頭文件
● .m, Ojbective-C實現(xiàn)文件
● .mm, Ojbective-C++的實現(xiàn)文件
● .cc, 純C++的實現(xiàn)文件
● .c, 純C的實現(xiàn)文件
分類的文件名應該包含被擴展的類的名字,如:GTMNSString+Utils.h或GTMNSTextView+Autocomplete.h。
2. 類名
· 類名(及其category name和protocol name)的首字母大寫,使用首字母大寫的形式分割單詞。
· 在面向特定應用的代碼中,類名應盡量避免使用前綴,每個類都使用相同的前綴影響可讀性。
· 在面向多應用的代碼中,推薦使用前綴。如:GTMSendMessage。
3. 方法名
· 方法名的首字母小寫,且使用首字母大寫的形式分割單詞。方法的參數使用相同的規(guī)則。
· 方法名+參數應盡量讀起來像一句話(如:)。在這里查看蘋果對方法命名的規(guī)范。
· getter的方法名和變量名應相同。不允許使用“get”前綴。如:
(id)getDelegate; // 禁止
(id)delegate; // 正確
· 本規(guī)則僅針對Objective-C代碼,C++代碼使用C++的習慣。
4.變量名
Objective-C 是區(qū)分大小寫的, 比如聲明一個描述圖片寬度的變量, pictureWidth 與 pictureWIDTH 或 PictureWidth 是不一樣的。 為了與大多數人的編程習慣一致,在變量名命名時,通常是把若干個詞組在一起,第一個詞的首字母小寫,其他所有詞的首字母大寫。 嚴格遵守這個約定,可以減少很多因區(qū)分大小寫帶來的錯誤。
在使用變量名時,要遵循一定的規(guī)則:
· 不能使用Objective-C 的保留字。所謂保留字,也就是在Objective-C 語言中已經有了特殊含義的單詞。 使用簡明的單詞組成變量名,比如picuteWidht 通常是安全的。為了確保變量名的可讀性,推薦在變量名中間使用大寫字母。
· 一個變量名不能以數字開頭,但數字可以出現(xiàn)在變量名中間。
· 可以使用下劃線 “_” , 下劃線可以用在變量的開頭,也可以用在變量的中間。
通過舉例說明以上規(guī)則。
合法的變量名寫法: picuture6s, picture_6s
不合法的變量名寫法: picuture 6 (中間有空格), 6Picuture (以數字開頭)
不推薦的變量名寫法: Picuture6s (開頭使用大寫字母)
|