iOS 項目開發(fā)規(guī)范
我們在做項目之前，都會根據(jù)公司的編程習慣來編寫。這樣才能很快的適應公司的工作習慣。良好的編程習慣，在無形中已經(jīng)為我們解決了很多問題。正好這幾天寫了公司的開發(fā)文檔和編程規(guī)范，順便總結(jié)一下。
1. 首先我們的項目目錄，要包含必要的文件：
- 工程名稱
- README.md 文件
- DevelopDocumention(開發(fā)文檔)
- Documentation(文件夾)
- CHANGLOG (日志)
具體可以根據(jù)公司要求再添加
2. 工程目錄說明
-
在寫代碼之前，我們要確保我們工程的模塊化，不能千篇一律，模糊化。這樣不至于后期我們這查找修改文件上花費時間。關(guān)于工程目錄怎么見，我們可以根據(jù)個人習慣和公司要求相結(jié)合，但是一定要確保，意義明確，查找方便。如下圖：
再具體功能模塊內(nèi)我們要，具體在模塊化，避免混亂，比如我們在一個類中可以分類：
- View Life (view 生命周期調(diào)用的方法)
- Private Method (私有方法)
- Extension /delegate(擴展代理方法)
- 屬性的 setter 與 getter
可以根據(jù)自己的編程習慣以及項目需求，添加分類和更改順序
3 第三方庫
我們可以cocoaPod 管理工具 導入三方庫。并把三方庫規(guī)范化處理。好的三方庫可以極大地加大我們開發(fā)的效率。
更多三方庫地址參考博客地址:http://blog.csdn.net/sunnyboy9/article/details/50976137
4 命名規(guī)范
1）類
遵循大駝峰命名法(例如:ExamPaperController)
Controller 命名:XXXController(TableViewControll
er 子類命名規(guī)范:XXXTableController)View 子類命名規(guī)范:XXXView (View 的 Xib 與相應的類同名)
2） 協(xié)議
- 遵循大駝峰命名法
- 協(xié)議寫在相應模塊的 protocols 中
- 命名規(guī)范:XXXProtocol,XXX 和相應類名一致
3）枚舉
- 遵循大駝峰命名法
- 枚舉值得變量以枚舉名開頭
- OC與Swift有區(qū)別注意
4） 方法
- 遵循小駝峰命名法
- 方法名須起有意義的單詞組成
- 每個方法里不能有太多的行代碼
5） 變量
- 遵循小駝峰命名法
- 變量必須起有意義的名字
- 控件類型變量命名尾綴添加相應類型(列如:UILabel 的類型變量: lblXXX)
6） 注釋
- 變量注釋應詳細描述變量用處(文檔注釋)
- 枚舉注釋應詳細描述枚舉和每一個元素用處(文檔注釋)
- 方法注釋應詳細描述方法作用、參數(shù)意義、返回值意義(文檔注釋)
- 其他使用單行注釋
7） 資源文件規(guī)范
- 資源文件全部放入 Supporting Files 文件夾下
- 圖片資源放入 Assert.xcassets. 可以建立自己的 Folder
- 其他資源可以放在 Resources 中(將各個資源按照文件分類放在相應文件夾內(nèi),列如:
音頻、視頻、圖片)
5 單元測試
Apple 自帶的 XCTes
第三方 GHUnit
推薦使用 XCTest,github 上大部分框架都是 XCTest 集成的,而且它還是 apple 自帶的框架。 Quick 安卓和 iOS 通用 也很方便
