2018-01-22

iOS开发规范

1. 关于命名

1、统一要求

• 含义清楚，尽量做到不需要注释也能了解其作用，若做不到，就加注释
• 使用全称，不适用缩写

• 类的命名
  • 大驼峰式命名：每个单词的首字母都采用大写字母
• 例子：MFHomePageViewController
• 后缀要求
  • ViewController: 使用ViewController做后缀
  • 例子: MFHomeViewController
• View: 使用View做后缀
  • 例子: MFAlertView
• UITableCell:使用Cell做后缀
  • 例子: MFNewsCell
• Protocol: 代理对象所遵守的代理Delegate必须使用mark来分区。
  • 例子:#pragma mark - UITableViewDelegate

2、类的命名

• 小驼峰式命名：第一个单词以小写字母开始，后面的单词的首字母全部大写
  • 例子：firstName、lastName
• 第一个单词首字母小写
  • 例子：NSString * somePrivateVariable
• 私有变量放在 .m 文件中声明
• 声明控件命名：遵从以上命名规范后缀必须加上控件名称
  • 例子：@property(nonatomic, strong)UITextField* nameTextField;

3、宏命名

• 以字母 k 开头，后面遵循大驼峰命名。[不带参数]
  • 例子：#define kWidth self.frame.size.width
• 小驼峰命名。[带参数]
  • define getImageUrl(url) [NSURL URLWithString:[NSString stringWithFormat:@"%@%@",kBaseUrl,url]]
• 常量以小写字母k开头，后续首字母大写
  • static NSString *kName = @"name";
• .m文件例如@"/sg/updateContacts”的字符串，请在当前.m文件定义常量，不要在.h文件定义
• 保持.h文件除了公用的属性和方法，不要再有其他代码。
• 当前类需要用到static常量或宏请写在当前类的.m文件的头部
• 如果有多个类要引用枚举和常量，2个类以上请写在公共类，2个以下可以写在.h文件方便引用。

• Enum

  • Enum类型的命名与类的命名规则一致

---

2. 关于注释

• 最好的代码是不需要注释的，尽量通过合理的命名。
• 良好的代码把含义表达清楚，在必要的地方添加注释。
• 注释需要与代码同步更新
  　如果做不到命名尽量的见名知意的话，就可以适当的添加一些注释或者mark。
• .h文件中能用@class就用，不要在.h文件中导入非必要的头文件
  不要信任接口提供的参数类型，接口每个做判断校验，参数超过3个必须建立Model。

1. 属性注释

• 例子： @property (nonatomic, strong) Student *student;//学生

2. 方法声明注释：

      /** 写明原因+注释者
   　　* @brief 登录验证
   　　*
   　　* @param personId 用户名
   　　* @param password 密码
   　　* @param complete 执行完毕的block
   　　*
   　　* @return
   　　*/

3. .m方法分区：

    建议使用“#pragma mark”，方便阅读代码
    #pragma mark - Action
    例子- (void)cancelClick:(UIButton *)button

    #pragma mark - UITableView
    - (NSInteger)numberOfSectionsInTableView:(UITableView *)tableView