每個公司甚至每個程序員都有自己的一套編碼習慣,個體不同屹徘,風格自然是迥異的走趋,為了項目的代碼質(zhì)量,團隊往往會制定自己的編碼規(guī)范噪伊。這是我們整理的編碼規(guī)范簿煌,發(fā)表出來供大家參考喲。
iOS 編碼規(guī)范
時間:2017-05-10 版本:1.0
前言:規(guī)范的編碼可以避免很多問題鉴吹,提高項目的穩(wěn)定性姨伟,也增加了易讀性和可維護性,所以豆励,現(xiàn)在初步建立一套編碼規(guī)范夺荒,之后再逐步完善。
1良蒸、命名規(guī)范
原則:
1)可讀性高技扼;
2)防止命名沖突;
類的命名
命名規(guī)范:
類名首字母大寫嫩痰,遵循OC語言的命名規(guī)范剿吻。類名要有實際的意義,如果類名太長串纺,可
以省略一些不影響實際意義的單詞丽旅,稍作簡寫椰棘。例如:
HomePageItemViewController ——> HomePageItemController
省略中間的view,大家依然知道它是一個VC魔招,并不影響實際意義和可讀性晰搀。
命名規(guī)則:
文件夾名字——類名——所屬MVC類型結(jié)尾
例如:
HomeDetailViewController,————控制器
HomeDetailCell,————————-視圖顯示器
HomeDetailModel————————數(shù)據(jù)模型
變量命名
變量名稱要有實際意義;
變量命名遵循OC的駝峰式命名規(guī)范办斑;
如果是一個View外恕,要以實際類型結(jié)尾;
變量名保持全英文結(jié)構(gòu)乡翅,不要出現(xiàn)數(shù)字鳞疲。
例如:cancelButton,titleLabel
常量命名
常量命名以m開頭蠕蚜;
遵循駝峰命名規(guī)范尚洽;
例如:#define mScreenWidth ([UIScreen mainScreen].bounds.size.width)
方法名命名
小寫字母開頭;
有實際意義靶累;
方法名前面一定要有注釋腺毫;
公有方法最好以類名開頭。
例如:
/**
- 保存圖片到相冊
- @param image 圖片
- @param success 成功回調(diào)
- @param failure 失敗回調(diào)
/
/ + (void)saveImageToAppAlbum:(UIImage)image success:(void (^)())success failure:(void (^)(NSError *error))failure;
2挣柬、資源文件
圖片資源
資源文件存儲按照功能分類潮酒,按照現(xiàn)有項目舉例,項目中有“首頁”邪蛔,“訂閱”急黎,“發(fā)現(xiàn)”,“我”四個模塊侧到,圖片資源就按照如下圖大致分類:
圖片資源的命名要遵循“文件夾名字”—“子文件名字”—“圖片名字”勃教,如果圖片名字很長的情況下,可以省略最外層文件夾名字匠抗,不過不建議省略故源。圖片命名一定要是英文,禁止出現(xiàn)中文命名汞贸。
音頻心软,json,plist等其他資源文件
其他資源放在Supporting Files文件夾下著蛙,資源文件注意命名。
3耳贬、項目結(jié)構(gòu)
現(xiàn)在項目的整體結(jié)構(gòu)還是可以的踏堡,只是業(yè)務(wù)文件夾有些亂,沒怎么整理咒劲。
項目結(jié)構(gòu)上還是遵循MVC結(jié)構(gòu)顷蟆,按照功能分诫隅,一個模塊一個文件夾,再加上三方庫(如果使用pods帐偎,這個文件夾基本可以省略)逐纬,Common文件夾
Bussiness文件夾——業(yè)務(wù)
home——首頁
Common——公共
類中方法順序(這個協(xié)商決定就好)
從上到下依次是:
重寫父類的方法——> get/set——> 點擊方法 ——> 自定義方法 ——> 代理方法