代码规范

代码规范

1.封装

所有方法、属性名称严格仿照苹果API的命名方式,做到见名思意。

2.命名规则

代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。正确的英文拼写和语法可以让阅读者易于理解,避免歧义。

* 注意:即使纯拼音命名方式也要避免采用。但alibab、taobao、youku、hangzhou等国际通用的名称,可视同英文.

大驼峰规则:每个单词的首字母大写。例:NameTextField

小驼峰原则:第一个单词首字母小写,其余都大写。例:nameTextField

类名前缀: 无需使用前缀,

类名后缀: 以控件名称为后缀,TableViewCellCollectionViewCell统一用Cell为后缀; 数据层统一以Model为后缀。如:

+ LoginView
+ LoginCell
+ LoginModel(数据层统一后缀为Model)

控制器: 在名称结尾缩写Controller,如: 类名+Controller

  • LoginController

属性: 除了Cell以外所有的控件和类名在名称结尾写全称(别管多长统一写全称!):

+ @property (nonatomic, strong) UIButton *loginButton;
+ @property (nonatomic, strong) UIButton *loginLabel;
+ @property (nonatomic, strong) UIButton *loginView;
+ @property (nonatomic, strong) UIButton *loginTextField;
+ @property (nonatomic, strong) UIButton *loginTextView;

变量命名,以下划线'_'开头:

  • BOOL _isLoginOtherDevice;

常量命名,以通知举例: 模块+动作+Notification

  • LivingPraiseCountNotification
  • GOWHBChatListCountNotification

以请求头拼接举例: 模块+用途

  • ShoppingAddNewAddress
  • GroupChatCreateNewGroup

枚举命名,应以枚举类型开头,以枚举标记为辅:

typedef NS_ENUM(NSInteger,UITableViewScrollPosition)
{
UITableViewScrollPositionNone,
UITableViewScrollPositionTop,
UITableViewScrollPositionMiddle,
UITableViewScrollPositionBottom,
};

3.全局的变量尽量使用常量,用extern进行拓展,不要使用宏。

4.不使用pch文件,把常用的头文件放在自定义的头文件包含,能用常量就不要使用宏,不常用的头文件用到再包含。

5.注释规范

为了减少他人阅读你代码的痛苦值,请在关键地方做好注释。

类注释

//
//  MyViewController.m
//  text
//
//  Created by 林霞 on 2017/9/12.
//  Copyright © 2017年 林霞 [email protected]. All rights reserved.
//

该注释是自动生成的,在xcode中设置即可。Created by 电脑用户名 on 创建该文件的时间。Copyright 2017 后面的名字和邮箱是自己填写和设置的。具体可在xcode工程,Project Document中设置。这样便可在每次新建类的时候自动加上该头注释。

方法注释

方法注释,方法外部统一用option + command + /,方法内部统一用//注释。

/**
 测试
 */
- (void)text
{
    //测试按钮事件响应
}

6.h文件的引用必须使用@class,不要使用#import

7.使用NSDictionaryNSArrayNSString内容进行操作、处理服务器返回数据等操作时,应调用空值判断。

8.一定要注意自己接触过的类的dealloc必须要走

9.UIViewController请按照如下分类

#pragma mark - life cycle
#pragma mark - event response
#pragma mark - UITableViewDelegate && UITableViewDataSource
(代理顺序往下排列)
#pragma mark - getters and setters
#pragma mark - private

* 注意:所有视图或者对象的创建请尽量使用懒加载,调用的时候全部使用self.textBtn这样的方式。如果是确定的不可变数组、字典,可直接给定数组中的元素。(getters and setters分类中,懒加载可出现_调用对象,其它情况请遵循self.调用原则)

#import "ViewController.h" 

@interface ViewController () 
@property (nonatomic, strong)UIButton * textBtn; 
@end 

@implementation ViewController 

#pragma mark - life cycle 
- (void)viewDidLoad {
    [super viewDidLoad]; 
    [self.view addSubview:self.textBtn]; 
} 

- (void)didReceiveMemoryWarning { 
    [super didReceiveMemoryWarning];
    // Dispose of any resources that can be recreated.
 } 

#pragma mark - private 

#pragma mark - event response 

#pragma mark - UITableViewDelegate && UITableViewDataSource 
//(代理顺序往下排列) 

#pragma mark - CTAPIManagerCallBackDelegate 

#pragma mark - getters and setters 
- (UIButton *)textBtn { 
    if (_textBtn == nil) {
       _textBtn = [UIButton buttonWithType:UIButtonTypeCustom]; 
       _textBtn.frame = CGRectMake(300, 250, 100, 100); 
       _textBtn.backgroundColor = [UIColor yellowColor]; 
       _textBtn.titleLabel.text = @"text"; 
       [_textBtn addTarget:self action:@selector(text) forControlEvents:UIControlEventTouchUpInside]; 
     } 
     return _textBtn; 
} 
@end

10.变量和方法

变量和方法的命名都遵循小驼峰命名。例如:textVariableStr, - (void)textAction响应事件。
变量命名对照表(如果用到下表中没有列举出来,请去掉UI、NS遵循实际规则即可。或者一看就知道的通用简写)
方法命名对照表(方法多为动词或动名词)

功能 示例
- (id)initXX. 初始化相关方法,使用init为前缀标识,如初始化布局- (id)initView
- (BOOL)isXX. 方法返回值为boolean型的请使用is前缀标识
- (UIView *)getXX 返回某个值的方法,使用get为前缀标识
- (void)setXX 设置某个属性值或者相关数据
- (void)updateXX 更新数据
- (void)saveXX 保存数据
- (void)drawXX 绘制相关,使用draw前缀标识
- (void)clearXX 清除数据
- (void)XXXAction 响应事件,使用Action为后缀标识
- (void)loadData 加载数据(一般情况下VC中都会有这个方法)
- (void)loadMoreData 加载更多数据
- (void)setupUI 加载布局(一般情况下VC中都会有这个方法)

11.参数名

参数名以小驼峰命名,尽量参考苹果原生方法风格编写。尽量可读性好,看到方法名就知道这个方法是用来干什么的。参数应该避免用单个字符命名。例:- (void)setDataImageUrl:(NSString *)imageUrl name:(NSString *)nameStr content:(NSString *)contentStr

12.文件夹命名

创建文件夹最好创建实体文件夹,找到工程目录,创建相应文件夹并拖入工程。文件夹命名使用相应模块结构分层的英文,首字母要大写。例:Model,View,Controller,Tool,Other,Service等等。

13.编码规范

  • 所有的方法之间空一行。
  • 所有的代码块之间空一行,删除多余的注释。
  • 所有自定义的方法需要给出注释。
  • 尽量使用懒加载,在控制器分类时有提及和要求,其它自定义类按照控制器格式分类,没有的分类不写即可。
  • 代码后的’{‘不需要独占一行,包括方法之后,if,switch等。
  • 必须要统一的要求,属性的定义请按照下图property之后,空一格,括号之后空一格,写上类名,空一格之后跟上*和属性名。
@property (nonatomic, strong) UITableView *tableView;
@property (nonatomic, strong) DeliveryModel *delivery;
@property (nonatomic, strong) DeliveryLookAdapter *lookAdapter;
@property (nonatomic, strong) DeliveryLookAPIManager *lookManager;
  • 遵循一般代码规范,多模仿苹果API。
  • 删除不用的代码。
  • 如果有方法一直不会用到,请删除(除工具类)。
  • 没有执行任何业务逻辑的方法,请删除或给予注释,删除多余的资。源或文件,添加必要的注释。
  • 比较大的代码块需要给出注释。

14.其它规范

  • 建议项目统一使用Masonry和xib结合的方式布局。不允许出现直接设置frame的情况。如果是纯代码的项目,不允许出现xib和拉约束的情况。不建议使用纯storyboard开发。
  • 数据提供统一的入口。无论是在 MVP、MVC 还是 MVVM 中,提供一个统一的数据入口,都可以让代码变得更加易于维护。比如可使用一个DataManager,把 http、preference、eventpost、database 都放在DataManger里面进行操作,我们只需要与DataManger打交道
  • 提取方法,去除重复代码。对于必要的工具类抽取也很重要,这在以后的项目中是可以重用的。
  • 尽可能的使用局部变量
  • 尽量减少对变量的重复计算。
  • 尽量在合适的场合使用单例。使用单例可以减轻加载的负担,缩短加载的时间,提高加载效率。但并不是所有的地方都适用于单例,简单来说单例主要适用于以下三个方面:
    1. 控制资源的使用,通过线程同步来控制资源的并发访问。
    2. 控制实例的产生,以达到节约资源的目的。
    3. 控制数据的共享,在不建立直接关联的条件下,让多个不相关的进程或线程之间实现通信。
  • 最后不要忘了检测内存泄漏。可使用Instruments分析内存。

你可能感兴趣的:(代码规范)