養成良好的編程習慣,是開始一門新語言的首要前提。
(一)文檔結構規范
1.建立Libs文件夾,存放第三方庫
2.建立Tools文件夾,存放自己封裝的類庫
3.建立ViewControllers文件夾,存放所有的ViewControl
4.建立Request文件夾,存放網絡請求
5.建立Cell文件夾,存放列表item
6.在Supporting Files文件夾下建立Images、Music和Video等相關文件夾,分別存放圖片、音頻、視頻等資源。
7.建立RootViewController首頁,放在底層目錄
8.建立Constant.h文件,放在底層目錄,存放常量
范例如下:
(二)命名規范
1.常量名全大寫,可用下劃線分隔,如:MY_LOTTERY_ID
2.變量首字母小寫,後面單詞首字母大寫,如myLotteryId
3.類名首字母大寫,如@interface MyLotteryId:NSObject
4.命名時帶上類型,如xxxTv,xxxView,xxxStr等
常見類型簡寫如下:
UIViewController:VC UIImage:Img UIImageView:Iv
UIView:View UILabel:Lbl UIButton:Btn
UINavigationBar:NBar UIToolBar:TBar UISearchBar:SBar
UITextField:Tf UITextView:Tv NSArray:Array
NSMutableArray:MArray NSDictionary:Dict NSMutableDictionary:MDict
NSString:Str NSMutableString:MStr NSSet:Set NSMutableSet:MSet
5.靜態變量前面加s標示,如sLotteryId
更多命名規范可參加蘋果官方文檔
(三)編碼習慣
1.每個文件前簡要描述該文件作用
2.類中功能模塊用#pragma mark - 做好備注,方便查找和代碼管理
3.NSLog測試完統一刪除
4.程序中變量方法名,盡量用命名標示功能,無法標示的用注釋說明
5.在pch文件中做加載預處理和log自動去除設置
6.類代碼行數盡量不超過300行,一個函數不超過100行,超過的考慮重構
7.創建Constant.h文件存放常量