代码规范
前言:代码规范化的第一个好处就是看着整齐、舒服。统一的风格使得代码可读性大大提高,看到任何一段代码都会觉得异常熟悉。规范的代码可以促进团队合作,规范的代码可以减少bug处理,规范的代码可以降低维护成本,规范的代码有助于代码审查,养成代码规范的习惯,有助于程序员自身的成长。
1、变量命名、方法名要求看其名知其意(词穷辅助中文注释)
小驼峰法:第一个单词首字母小写,后面其他单词首字母大写。例如
@property (nonatomic, strong) NSString *userName;
- (instancetype)initWithFrame:(CGRect)frame;
2、类名:前缀FM+模块名称+功能名称+后缀(VC控制器、View视图、model模型、viewModel逻辑处理类)
大驼峰法: 把第一个单词的首字母也大写了。例如:
@interface FMHomeLoginVC : UIViewController
3、水平留白(代码空格)
操作符左右一定有空格,例如
i = i + 1;
分隔符(, 和;)前一位没有空格,后一位保持空格,例如:
int i, j;
for (int fastIndex = 0; fastIndex < nums.size(); fastIndex++)
控制语句(while,if,for)后都有一个空格。例如:
while (n) {
if (k > 0) return 9;
n--;
}
方法外部上下换一行,内部不要有换行,花括号和函数保持同一行,并有一个空格,例如:
- (void)viewWillAppear:(BOOL)animated {
[super viewWillAppear:animated];
}
- (void)dealloc {
//TODO 暂时还没有什么需要手动释放的
}
单文件全局静态常量、宏代码定义全部大写并用_连接。例如:
#define SCREEN_WIDTH ([[UIScreen mainScreen]bounds].size.width)
static const CGFloat DEFAULT_LINE_HEIGHT = 3;
4、完整示例
代码规范示例图.png
5、单例的固定写法
+ (id)sharedInstance {
static dispatch_once_t once = 0;//保证其block块在应⽤用中只执⾏行⼀一次
static id _sharedObject = nil;
dispatch_once(&once, ^{
_sharedObject = [[self alloc] init];
});
return _sharedObject;
}
7、编程中的六大设计原则?
开发新功能模块尽量遵循这六大设计原则
- 1.单一职责原则
通俗地讲就是一个类只做一件事
CALayer:动画和视图的显示。
UIView:只负责事件传递、事件响应。
- 2.开闭原则
对修改关闭,对扩展开放。 要考虑到后续的扩展性,而不是在原有的基础上来回修改
- 3.接口隔离原则
使用多个专门的协议、而不是一个庞大臃肿的协议,如 UITableviewDelegate + UITableViewDataSource
- 4.依赖倒置原则
抽象不应该依赖于具体实现、具体实现可以依赖于抽象。 调用接口感觉不到内部是如何操作的
- 5.里氏替换原则
父类可以被子类无缝替换,且原有的功能不受任何影响 如:KVO
- 6.迪米特法则
一个对象应当对其他对象尽可能少的了解,实现高聚合、低耦合
8、JuApp目录结构
目录架构图.png