iOS客户端开发规范

一、文件分类

在相应的模块下建立文件夹，

所有ViewController都放在ViewController文件夹下,所有的View放在view文件夹下，所有model放在model文件夹下，Category放在Category文件夹下，功能型类放在Tools文件夹下，数据库或CoreData操作放在DAO文件夹下。

二、命名规则

1、含义清楚，尽量做到不需要注释也能了解其作用，若做不到，就加注释

2、使用全称，不适用缩写

3、文件名使用：大驼峰法+后缀  eg:CreateNoteViewController、NoteListCell、NoteDetailView等（首字母大写），在文件顶部的注释中简要说明该类的作用或页面名称。

4、文件名后缀ViewController: 使用ViewController做后缀eg: MFHomeViewController、View: 使用View做后缀 eg: MFAlertView 、 UITableCell:使用Cell做后缀 eg: MFNewsCell、 Protocol: 使用Delegate或者DataSource作为后缀 eg: UITableViewDelegate、UITableViewDataSource  UI控件依次类推

5、私有变量、property变量命名要用小驼峰法（首字母小写），要体现出该变量和函数的意义。私有变量放在 .m 文件中声明

6、宏命名

全部大写，单词间用 _ 分隔。[不带参数]

eg: #define THIS_IS_AN_MACRO @"THIS_IS_AN_MACRO"

以字母 k 开头，后面遵循大驼峰命名。[不带参数]

eg：#define kWidth self.frame.size.width

小驼峰命名。[带参数]

#define testMyCondition(condition) (condition*5)

 

7、Enum

Enum类型的命名用大驼峰法

Enum中枚举内容的命名需要以该Enum类型名称开头

eg:

1 typedef NS_ENUM(NSInteger, AFNetworkReachabilityStatus) {

2     AFNetworkReachabilityStatusUnknown= -1,

3    AFNetworkReachabilityStatusNotReachable = 0,

4    AFNetworkReachabilityStatusReachableViaWWAN = 1,