2021-02-23

iOS 注意事项及代码规范

注意事项:
健壮性检查（尤其是空指针异常，数组边界溢出）
是否无意中陷入了死循环
是否存在内存泄漏的情况
是否存在运行时错误（除以零的情况）
是否存在主线程里面有耗时操作的情况
是否存在子线程里面有更新UI的情况
重用性检查（是否存在相同的方法写了两次，是否可以写成通用类、方法、组件等）
性能检查（UI布局是否最优，tableview等滑动页面是否卡顿）
是否存在同步执行太慢，需要转成异步执行的情况
是否存在重复多次或不合理调用接口情况

一、项目结构：（采用MVVM）
Appdelegate启动配置
Business：业务功能模块
Category：分类
Manager：管理类
Network： 接口管理文件
Res： 资源管理
Util： 公共方法
Constants:公共定义类
Framework：底层分装类文件
ThirdPart ：第三方库
Pods： cocoapod管理

二、代码规范：

1.关于命名
　<1> 统一要求
含义清楚，尽量做到不需要注释也能了解其作用，若做不到，就加注释
使用全称，不适用缩写
　<2> 类的命名
大驼峰式命名：每个单词的首字母都采用大写字母
　　　例子：HomeViewController
后缀要求
　 Controller: 使用Controller做后缀
　例子: MFHomeViewController
View: 使用View做后缀
例子: MFAlertView
UITableCell:使用Cell做后缀
例子: MFNewsCell
Protocol: 使用Delegate或者DataSource作为后缀
例子: UITableViewDelegate
UI控件依次类推
　<3> 私有变量
小驼峰式命名：第一个单词以小写字母开始，后面的单词的首字母全部大写
　　例子：firstName、lastName
以 _ 开头，第一个单词首字母小写
　　例子：NSString * _somePrivateVariable
私有变量放在 .m 文件中声明　
　<4> property变量
小驼峰式命名
　　　例子：///注释
　　　　　　@property (nonatomic, copy) NSString *userName;
　<5> 宏命名
全部大写，单词间用 _ 分隔。[不带参数]
　　例子: #define THIS_IS_AN_MACRO @“THIS_IS_AN_MACRO”
以字母 k 开头，后面遵循大驼峰命名。[不带参数]
　　例子：#define kWidth self.frame.size.width
小驼峰命名。[带参数]
　　#define getImageUrl(url) [NSURL URLWithString:[NSString stringWithFormat:@"%@%@",kBaseUrl,url]]
　<6> Enum
Enum类型的命名与类的命名规则一致
Enum中枚举内容的命名需要以该Enum类型名称开头
　　例子:
typedef NS_ENUM(NSInteger, AFNetworkReachabilityStatus) {
AFNetworkReachabilityStatusUnknown = -1,
AFNetworkReachabilityStatusNotReachable = 0,
AFNetworkReachabilityStatusReachableViaWWAN = 1,
AFNetworkReachabilityStatusReachableViaWiFi = 2
};

2.关于注释
　最好的代码是不需要注释的 尽量通过合理的命名
　良好的代码把含义表达清楚 在必要的地方添加注释
　如果做不到命名尽量的见名知意的话，就可以适当的添加一些注释或者mark
　<1> 关键属性注释
　<2> 方法声明注释

3.关于格式化代码
　<1> 指针 “" 位置
　　定义一个对象时，指针 "” 靠近变量
　　　例子: NSString *userName;
　<2> 方法的声明和定义
　　在 - 、+ 和 返回值 之间留一个空格，方法名和第一个参数之间不留空格

<3> 代码缩进
使用 xcode 默认缩进，即 tab = 4空格
相同类型变量声明需要独行声明
Method与Method之间空一行

<4> 对method进行分组
　　使用 #pragma mark - 方式对类的方法进行分组

<5> 大括号写法
　　　
对于其他使用场景: 左括号跟在第一行后边

任何需要写大括号的部分，不得省略