一、文件夾【業務模塊文件夾】
1、文件夾的名稱需要體現該模塊的功能概括。
如:main、scan、order、setting、login
2、二級文件夾根據編程設計模式分類命名,需要從下面詞語中取詞:
model、view、viewModel、controller
二、新建【子類】
1、類名
(1)遵循大駝峰命名法。
(2)TC+模塊概括名+功能分區名+父類的慣用后綴。比如:TCHomeViewController
(3)為了整個項目代碼的整潔與統一,建議使用List、Detail、Cell等字樣。
(4)模塊概括名一定要是統一的、明確的、唯一的代表模塊名稱。
(5)父類的慣用后綴的意思是:如果要從其他框架繼承子類,那么必須遵循其命名慣例。比如,繼承UIView的子類名稱必須以View結尾。
三、屬性
1、屬性名
(1)遵循小駝峰命名法、避免縮寫。
(2)后綴體現屬性的數據類型。比如:countLabel、rankButton、squareListDatas。
(3)使用長的、描述性的命名方向。比如myClueButton而不是myBtn。
(4)要求NSString nameString; 而不是NSString nameString; 或者NSString * nameString;。
2、屬性定義
(1)定義屬性的參數順序排序:原子性、內存管理。比如:@property (nonatomic, copy) NSString *carNoDetailStr;
四、變量
1、實例變量名
(1)在本函數內,使用下劃線開頭,在本函數以外使用下劃線開頭
(2)遵循小駝峰命名法、避免縮寫。
(3)后綴體現屬性的數據類型。比如:self.squareListDatas、self.allClueLabel。
2、方法名
(1)遵循小駝峰命名法、避免縮寫。
(2)不要使用“and”這個詞,它不應該用來闡明有多個參數。
(3)直接父類是其他框架:TC開頭。
3、全局變量
(1)遵循大駝峰命名法、避免縮寫。
.h文件
extern NSString *const TCTokenCheckRequestUserName;
extern NSString *const TCTokenCheckRequestPassword;
.m文件
NSString *const TCTokenCheckRequestUserName = @"userName";
NSString *const TCTokenCheckRequestPassword = @"password";
4、枚舉名
(1)遵循大駝峰命名法、避免縮寫。
(2)使用OC的枚舉方式。
(3)枚舉對象名:TC+枚舉范圍概括名+Type。比如:TCRegisterType
(4)枚舉種類名:TC+枚舉范圍概括名+Type_某種情況名。比如:TCRegisterType_Register。
5、協議名
(1)遵循大駝峰命名法、避免縮寫。
(2)代理協議:類名+Delegate。比如:YYBaseRequestManagerCallBackDelegate。
(3)數據源協議:類名+DataSource。比如:YYBaseRequestManagerParamSource。
(4)普通協議:類名+Protocol。比如:YYBaseRequestManagerProtocol。
四、常用工具
(1)統一歸放在tclibrary文件夾下。
(2)遵循大駝峰命名法、避免縮寫。如TCTimerCountDown、TCShareHandle。
五、第三方工具
(1)統一歸放在library文件夾下。
(2)遵循大駝峰命名法、避免縮寫。如AFNetworking、FMDB。
六:圖片資源文件組織
1、圖片資源文件
(1)使用Images.xcassets管理。
(2)避免出現中文。
(3)表現內容內容類型圖片狀態。