代码规范
方法的声明和定义
代码块
建议多使用代码块,可以增加代码的阅读性。
/**
* 视图初始化
*/
[self initWindow];
/**
* 请求框架设置
*/
[self settingNetWorkManager];
/**
* 智能键盘设置
*/
[self settingIQKeyboardManager];
/**
* 图片缓存设置
*/
[self settingSDWebImageManager];
#import VS #include 使用 #import 引入Ojbective-C和Ojbective-C++头文件,使用 #include 引入C和C++头
指针“* =”号的位置
UIImageView *imageView = [[UIImageView alloc] init];
变量
NSString *_varName;
常量(#define, enums, const等)使用大写,用_来分割单词。如:
URL_MAIN_VC
属性
@property (nonatomic, copy) NSString *aString;
成员变量使用 @private。如:
@interface MyClass : NSObject {
@private
id _myInstanceVariable;
}
在 - OR + 和返回值之间留1个空格,方法名和第一个参数间不留空格,并且{接在方法后边需要留一个空格。如:
- (void)doSomethingWithString:(NSString *)theString {
...
}
当参数过长时,每个参数占用一行,以冒号对齐。如:
- (void)doSomethingWith:(GTMFoo *)theFoo
rect:(NSRect)theRect
interval:(float)theInterval {
...
}
dealloc
- (void)dealloc {
NSLog(@"- [%@ dealloc]",[self class]);
}
待办事项
TODO:// or FIXME://
换行 尽量不要出现2行以上的换行,合理换行。
self.tableView = [[UITableView alloc] initWithFrame:CGRectZero style:UITableViewStyleGrouped];
[self.tableView setDataSource:self];
[self.tableView setDelegate:self];
[self.tableView setShowsVerticalScrollIndicator:NO];
[self.tableView setShowsHorizontalScrollIndicator:NO];
[self.view addSubview:self.tableView];
[self.tableView mas_makeConstraints:^(MASConstraintMaker *make) {
make.top.equalTo(@0);
make.left.equalTo(@0);
make.bottom.equalTo(@-49);
make.right.equalTo(@0);
}];
MJWeakSelf
self.tableView.mj_header = [MJRefreshNormalHeader headerWithRefreshingBlock:^{
[weakSelf getDataWithHeaderRefresh];
}];
方法的调用
调用方法沿用声明方法的习惯。例外:如果给定源文件已经遵从某种习惯,继续遵从那种习惯。
所有参数应在同一行中,或者每个参数占用一行且使用冒号对齐。如:
[myObject doFooWith:arg1 name:arg2 error:arg3];
或
[myObject doFooWith:arg1
name:arg2
error:arg3];
mark快速查找代码
pragma mark - UITableViewDelegate
命名
类名(及其category name 和 protocal name)的首字母大写,写使用首字母大写的形式
分割单词
在面向多应用的代码中,推荐使用前缀。如:BFSendMessage