IOS开发规范.docx

文档介绍：蓝色互动iOS 代码规范文档

上海科匠信息科技有限公司
iOS开发组编制
2014年4月16日
版本
修订内容
作者
时间

初稿
朱亮亮
2014-4-16

图片的位置做了修改
孟欢、严登峰、王宇
2015-4-20
目的
统一编程风格,提高的可读性与编码效率,避免团队开发可能带来的混乱。
适用范围
本规范适用于公司项目产品运用Objective-C作为开发语言的编码活动。
工程模板介绍
工程目录总览,所有项目都将copy模板工程,无需重新创建和配置新工程。
Roots
作用:只存放模块界面的根ViewController。
例如:项目中有个首页模块,则把首页模块的根视图控制器HomeViewController放到Roots中
UI
作用:存放所有新增UI界面。新的模块统一放在 UI 目录下,新建一个文件夹,然后在模块文件夹下面在新建 View 和 ViewController 两个目录,分别存放自定义的View和 ViewController。
例如:项目中有个首页模块,则在UI目录下,先创建首页目录,再在首页文件夹下创建View 和 ViewController 两个目录。首页模块中所有自定义的View全部放在此View目录中,首页模块下所有自定义的ViewController全部放在此ViewController目录中。
Extend
作用:存放所有自定义的Category和各种Util类。
例如:项目中需要自己写一个NSString+EncodingUTF8Additions,
则放在Extend中
Protocols
作用:存放单独创建的Protocol文件。(不准在此目录下新建任何目录和除Protocol以外的文件)
System
作用:存放所有系统级目录和类文件。(不准在此目录下新建任何目录和文件)
Base
作用:存放所有系统级父类文件。(不准在此目录下新建任何目录和文件)
例如:BMBaseView、
BMBaseViewController、
BMBaseTableViewCell
BD
作用:存放所有数据库操作类。所有对数据库的操作必须新建或存放到相应的Models类和Caches类中。其中Models类放到Models目录中,Caches类放到Caches目录中。
例如:注册、登录操作完成后要将数据保存到数据库中。先在Models目录下新建User类初始化相应属性,再在Caches目录下新建UserCache类进行实际的数据库操作。

作用:存放网络请求访问类。(不准在此目录下新建任何目录和文件)
Resource
作用:存放所有资源文件。(不准在此目录下新建任何目录和文件)
Images
作用:存放除app的Icon和开机画面以外的所有图片文件。
Media
作用:缩放所有多媒体文件,如各种音频、视频文件。(不准在此目录下新建任何目录和除音频、视频以外的其他文件)
Xibs
作用:存放所有xib文件。(不准在此目录下新建任何目录和除xib以外的其他文件)
Files
作用: 存放所有除上述三类以外的资源文件。(不准在此目录下新建任何目录、图片、音频视频、xib文件)
BMDefine
作用: 存放所有宏定义。(所有宏定义必须存放在此目录下。)
PluginTool
作用:存放所有第三方库、类文件。
代码规范
命名
目录命名
规定: 用英文命名时,首字母大写,可以用中文命名,但是禁止使用拼音命名。
类命名
规定: 必须采用驼峰命名法,单词首字母大写。尽量不要使用带前缀的类名,每个类都有相同前缀不能提高可读性。只有在写共用类时才推荐使用前缀,使用的前缀必须是BM。禁止使用中文、拼音等方式来命名。
例如:BMBaseView、BMDefine等。
类分类命名(Category)
规定: 必须采用格式:类名+分类名,即Xcode自动生成的命名格式。禁止使用中文、拼音等方式来命名。
例如:NSString+EncodingUTF8Additions。
方法命名
一般方法命名
规定:必须使用小写开头的驼峰法命名,每个参数都应该小写开头。禁止使用中文、拼音等方式来命名。方法与方法之间必须空行。
例如:
- (BOOL)application:(UIApplication *)application