自己整理的iOS开发规范

1、请在类文件顶部注明作者姓名(系统会默认生成)
举例：
Created by xxx on 17/11/16.
Copyright © 2017年 xxx. All rights reserved.

2、控件命名请使用控件作用拼接数据类型，见名知意
举例：
UIButton => submitBtn
UILabel => companyLabel
UIImageView => carImageView

3、一个方法中代码尽量不要超过20行，如超过请考虑按职责将代码拆分到子方法中，保障主方法流程清晰

4、坐标规范
当访问一个 CGRect 的 x， y， width， height 时，应该使用CGGeometry 函数代替直接访问结构体成员。

苹果的 CGGeometry 参考中说到：
All functions described in this reference that take CGRect data structures as inputs implicitly standardize those rectangles before calculating their results. For this reason, your applications should avoid directly reading and writing the data stored in the CGRect data structure. Instead, use the functions described here to manipulate rectangles and to retrieve their characteristics.

举例：
CGRect frame = self.view.frame;
CGFloat x = CGRectGetMinX(frame);
CGFloat y = CGRectGetMinY(frame);
CGFloat width = CGRectGetWidth(frame);
CGFloat height = CGRectGetHeight(frame);

不规范举例：
CGRect frame = self.view.frame;
CGFloat x = frame.origin.x;
CGFloat y = frame.origin.y;
CGFloat width = frame.size.width;
CGFloat height = frame.size.height;

5、关于注释
要求：
(1)、方法内注释请使用 双斜杠加空格再加说明文案
举例：
- (void)createView{
  // 这是一个正经的注释 
}

(2)、类、类成员（变量或方法）顶部应添加注释说明清楚类的职责、变量的作用或者方法的提供的功能
举例：在.h文件中增加注释
/*******************************************
*
*
*
*订单-分类界面
*
*
*
********************************************/

6、类的命名，每个单词的首字母都采用大写字母，目前项目统一以YF开头
如：

类	要求	例如
ViewController	使用Controller做后缀	例子: YFHomeController
View	使用View做后缀	例子: YFAlertView
UITableCell	使用Cell做后缀	例子: YFNewsCell
Protocol	使用Delegate或者DataSource作为后缀	例子: UITableViewDelegate
Model	使用model作为后缀	例子: YFDataModel
单例	manager	YFUserInfoManager
类的拓展	类名+项目简写+extra	例子: NSString+YFExtra

7、宏命名

类	要求	例如
宏定义方法	小驼峰命名	例子: getImageUrl(url) [NSURL URLWithString:[NSString stringWithFormat:@"%@%@",YFBaseUrl,url]]
宏定义常量	大驼峰命名	例子: #define KSelfWidth [UIScreen mainScreen].bouds.size.width

8、变量的命名：用修饰+类型的方式

要求	例如
用修饰+类型的方式（小驼峰式命名）	UIButton *settingButton

9、property变量

要求	例如
小驼峰式命名	@property (strong, nonatomic) NSSNumber *userId;
NSString 使用copy	@property (nonatomic, copy) NSString *userName;
所有属性特性应该显式地列出来	@property (nonatomic,weak) IBOutlet UIView *containerView;

10、图片命名

要求	例如
功能名称控件类型自定义参数	car_easy_share_btn_weixin;

11、枚举类型
要求：
项目简写开头，跟随其后的命名应采用驼峰命名法则，命名应准确表述枚举表示的意义，枚举中各个值都应以定义的枚举类型开头，其后跟随各个枚举值对应的状态、选项或者状态码

举例：
typedef NS_ENUM(NSInteger, YFRequestState) {
    YFRequestStateInactive,
    YFRequestStateLoading
};

12、方法命名
要求：
(1)、使用小驼峰法，规范的方法名应该看起来像一个完整的句子，读过便知函数作用
(2)、在(-/＋ )符号之后应加上一个空格

举例：
- (void)setExampleText:(NSString *)text image:(UIImage *)image;
+ (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;

13、代理命名
要求：
(1)、名称以标示发送消息的对象的类名开头,省略类名的前缀并⼩小写第⼀个字⺟

举例：
- (BOOL)tableView:(NSTableView*)tableView shouldSelectRow:(int)row;
- (BOOL)application:(NSApplication *)sender 
           openFile:(NSString *)filename;

14、代码组织
要求：
(1)、在函数分组和protocol/delegate实现中使用#pragma mark -来分类方法

结构按照功能模块划分：
懒加载
控制器生命周期
私有方法
通知方法
代理方法
公共方法
触发事件

举例：
#pragma mark ********【懒加载】********支付弹框视图

15、关于空格
要求：
(1)、类方法声明在方法类型与返回类型之间要有空格
举例：
- (void)methodName:(NSString *)string;

(2)、条件判断的括号内侧不应有空格
举例：
if (a < b) {
    // something
}

(3)、关系运算符（如 >=、!=）和逻辑运算符（如 &&、||）两边要有空格
举例：
(someValue > 100)? YES : NO

(4)、代码行与行之间应最多只有一行空格，当代码关联性较大时，应不予空格
举例：
YFRentMyOrderController *vc = [[YFRentMyOrderController alloc]init];
vc.isFromMessageVc = YES;
[self.navigationController pushViewController:vc animated:YES];

不规范举例：
YFRentMyOrderController *vc = [[YFRentMyOrderController alloc]init];
vc.isFromMessageVc = YES;

[self.navigationController pushViewController:vc animated:YES];

16、布尔变量
要求：
(1)、因为"1"、YES都可以代表YES,所以不要直接将字符串与"1"比较来判断是否是YES

举例：
NSString *str = @"1";
BOOL isNeedRefresh = [str boolValue];
if (isNeedRefresh) {
    //dosomething
}

不规范举例：
NSString *str = @"1";
if ([str isEqualToString:@"1"]) {
    //dosomething
}

17、条件语句
要求：
为避免错误，条件语句体必须使用大括号，即便语句体中的语句可以不必使用大括号（比如只有一行语句）。常见的错误包括在不使用大括号的情况下添加第二行语句，以为它属于if语句的一部分。此外，更可怕的事情是，如果条件语句中的代码行被注释，则本不属于条件语句的下一行代码将变成条件语句的一部分。此外，这种编码风格和所有其它条件语句均保持一致。

举例：
if (!error) {
  return success;
}

不规范举例：
if (!error)
  return success;
或
if (!error) return success;

18、三目运算符
要求：
仅当使用该运算子可以让代码显得更清晰易懂时方可使用三元运算子。更多情况下应使用条件语句。使用类似if的条件语句对多种条件进行判断通常要更容易理解，或使用实例变量

举例：
result = a > b ? x : y; 

不规范举例：
result = a > b ? x = c > d ? c : d : y;

19、关于懒加载
懒加载适合的场景：
(1)、一个对象的创建依赖于其他对象。
(2)、一个对象在整个app过程中，可能被使用，也可能不被使用。
(3)、一个对象的创建需要经过大量的计算或者比较消耗性能。

建议：
不要滥用懒加载，只对那些真正需要懒加载的对象采用懒加载。除以上三条之外，请不要使用懒加载。

20、工程结构规范
要求：
为了避免文件杂乱，物理文件应该保持和 Xcode 项目文件同步。Xcode 创建的任何组（group）都必须在文件系统有相应的映射。为了更清晰，代码不仅应该按照类型进行分组，也可以根据业务功能进行分组

本文仅作为约束自己代码风格的一种代码规范，如有不同见解欢迎评论区留言交流。

自己整理的iOS开发规范

你可能感兴趣的:(自己整理的iOS开发规范)