乐乎-代码规范概述

参考:

1、iOS中书写代码规范35条小建议

2、iOS开发总结之代码规范

3、iOS代码编程规范-根据项目经验汇总

4、iOS开发规范

代码结构规范

1、Model 统一放到App_Model,建立对应模块的目录。服务器返回数据,建立model。请求参数也尽量建立RequestObject,放在App_Web/RequestModel。

2、功能模块目录App_Code。1、每个模块建立实体目录。2、子目录(实体目录):ViewController、Model、View、Others。3、子文件可建立虚拟目录(虚拟目录可以用中文)。4、view、controler命名加前缀(每个模块都要加上自己的前缀,比如相册模块(PhotoGallery)的代码都以PG作为前缀: PGAlbumViewController, PGDataManager)。

3、第三方库使用cocoa pod管理,使用第三库进行一层封装,放在podLibrary。本地第三方库管理,分类:SDK、Tools、ViewControls、Public、Modify。及自己创建的组件。

4、类中功能模块以#pragma mark – 分割,上空两行,下空一行

5、不能使用魔法数字,颜色、常量、key、尺寸、复用的图片等统一定义,定义在App_Data。可以细分文件,方便分离。

6、数据合法性验证,逻辑必须闭包比如:if--else。

7、统一工具类使用。网络请求、数据缓存、模型转换、ui组件、系统分类等

8、.h 文件写的所有代码都尽量写注释。如果是内部使用的属性, 那么就定义成私有的属性(定义到.m的class extension里面)

9、commit代码之前一定要保证木有warning, 木有内存泄露, 确保都OK之后再上传代码

命名规范

编码规范简单来说就是为了保证写出来的代码具备三个原则:可复用, 易维护, 可扩展.

你可能感兴趣的:(乐乎-代码规范概述)