每個公司甚至每個程式員都有自己的一套編碼習慣,個體不同,風格自然是迥異的,為了項目的代碼品質,團隊往往會制定自己的編碼規範。這是我們整理的編碼規範,發表出來供大家參考喲。
iOS 編碼規範
時間:2017-05-10 版本:1.0
前言:規範的編碼可以避免很多問題,提高項目的穩定性,也增加了易讀性和可維護性,是以,現在初步建立一套編碼規範,之後再逐漸完善。
1、命名規範
原則:
1)可讀性高;
2)防止命名沖突;
類的命名
命名規範:
類名首字母大寫,遵循OC語言的命名規範。類名要有實際的意義,如果類名太長,可
以省略一些不影響實際意義的單詞,稍作簡寫。例如:
HomePageItemViewController ——> HomePageItemController
省略中間的view,大家依然知道它是一個VC,并不影響實際意義和可讀性。
命名規則:
檔案夾名字——類名——所屬MVC類型結尾
例如:
HomeDetailViewController,————控制器
HomeDetailCell,————————-視圖顯示器
HomeDetailModel————————資料模型
變量命名
變量名稱要有實際意義;
變量命名遵循OC的駝峰式命名規範;
如果是一個View,要以實際類型結尾;
變量名保持全英文結構,不要出現數字。
例如:cancelButton,titleLabel
常量命名
常量命名以m開頭;
遵循駝峰命名規範;
例如:#define mScreenWidth ([UIScreen mainScreen].bounds.size.width)
方法名命名
小寫字母開頭;
有實際意義;
方法名前面一定要有注釋;
公有方法最好以類名開頭。
/**
- 儲存圖檔到相冊
- @param image 圖檔
- @param success 成功回調
-
@param failure 失敗回調
/
/ + (void)saveImageToAppAlbum:(UIImage)image success:(void (^)())success failure:(void (^)(NSError *error))failure;
2、資源檔案
圖檔資源
資源檔案存儲按照功能分類,按照現有項目舉例,項目中有“首頁”,“訂閱”,“發現”,“我”四個子產品,圖檔資源就按照如下圖大緻分類:
image.png
圖檔資源的命名要遵循“檔案夾名字”—“子檔案名字”—“圖檔名字”,如果圖檔名字很長的情況下,可以省略最外層檔案夾名字,不過不建議省略。圖檔命名一定要是英文,禁止出現中文命名。
音頻,json,plist等其他資源檔案
其他資源放在Supporting Files檔案夾下,資源檔案注意命名。
3、項目結構
現在項目的整體結構還是可以的,隻是業務檔案夾有些亂,沒怎麼整理。
項目結構上還是遵循MVC結構,按照功能分,一個子產品一個檔案夾,再加上三方庫(如果使用pods,這個檔案夾基本可以省略),Common檔案夾
Bussiness檔案夾——業務
home——首頁
Common——公共
類中方法順序(這個協商決定就好)
從上到下依次是:
重寫父類的方法——> get/set——> 點選方法 ——> 自定義方法 ——> 代理方法