命名
- 命名統(tǒng)一使用駝峰命名法;只采納有廣為人知含義的縮寫(xiě)需纳,比如info芦倒、msg、UI不翩、HTTP這類(lèi)兵扬。自造的縮寫(xiě)不被認(rèn)可】隍穑總體的命名原則是清晰和一致器钟,避免歧義,同樣要確保類(lèi)名需要大寫(xiě)字母開(kāi)頭妙蔗。
- 公共類(lèi)名需要結(jié)合項(xiàng)目名稱(chēng)來(lái)命名傲霸,確保整個(gè)項(xiàng)目中的自定義類(lèi)的名稱(chēng)開(kāi)頭是統(tǒng)一的。
- 模塊內(nèi)類(lèi)名命名需結(jié)合功能或者模塊眉反,并且尾部要帶上該類(lèi)的類(lèi)型昙啄,比如UIViewController的子類(lèi)命名為JasonIndexController。
- 成員變量命名小寫(xiě)字母開(kāi)頭寸五,使用下劃線作為變量的前綴梳凛;屬性和局部變量命名不需要使用下劃線作為變量的前綴或者后綴,全局變量使用下劃線作為變量的后綴梳杏。
- 方法命名小寫(xiě)字母開(kāi)頭(方法以大寫(xiě)縮略詞開(kāi)始的除外)韧拒,文件夾首字母大寫(xiě)開(kāi)頭。不要使用下劃線開(kāi)頭作為方法的前綴十性。
- 項(xiàng)目中所有Group或者文件名稱(chēng)(圖片名字等)叭莫,不要使用漢字命名,盡量使用英文命名烁试,國(guó)內(nèi)特有名詞可以使用拼音雇初。
- 圖片命名以英文小寫(xiě)“模塊名_圖片名”來(lái)命名,并且同樣不能使用中文减响。
Objective-C下的cocoa編碼規(guī)范
- 使用
#pragma mark
來(lái)分類(lèi)方法靖诗,參考以下結(jié)構(gòu):#pragma mark – Life Cycle
郭怪。 - .h文件中使用
@class
聲明OC文件; .m文件中使用#import
引入oc文件。 - 盡量減少公開(kāi)的api接口數(shù)量
- 枚舉的定義使用如下的方式:
typedef NS_ENUM(NSUInteger, UISearchBarStyle) { UISearchBarStyleDefault, // currently UISearchBarStyleProminent UISearchBarStyleProminent, // used my Mail, Messages and Contacts UISearchBarStyleMinimal // used by Calendar, Notes and Music }
注釋要求
新版Xcode自帶有添加注釋的功能
- 單行注釋?zhuān)涸诜椒ǖ牡胤桨?Command+/
- 方法注釋?zhuān)旖萱I是Command + Option + /(需要在方法名的上面(空白)的地方按 Command + Option + / 才管用)
- 在新建一個(gè)類(lèi)的時(shí)候刊橘,需要在頭文件中添加注釋?zhuān)瑏?lái)表明這個(gè)類(lèi)的作用鄙才。
- 一些過(guò)于簡(jiǎn)單的注釋盡量不要加。
其他
- 懶加載代碼放在最底部