代码规范

代码规范

方法的声明和定义

代码块

建议多使用代码块,可以增加代码的阅读性。
/**
 *  视图初始化
 */
[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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • iOS编程规范0规范 0.1前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、可靠、可 测试、高效...
    iOS行者阅读 9,929评论 21 35
  • 点击查看简书原文 一. 格式化代码 1. 指针“*”号的位置 2. 空格 VS tabs ▪ 只允许使用空格,将编...
    漂泊海上的大土豆阅读 5,807评论 0 8
  • 注: Copy 自 cocoachina 英文原文:Swift Style Guide 翻译作者:码农网 – 豆照...
    Mid_Chan阅读 4,030评论 0 0
  • 推荐文章:禅与 Objective-C 编程艺 前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、...
    WolfTin阅读 7,846评论 0 1
  • 我爱的她有你的影子 熟睡的时候像个天真的孩子 我爱的她有你的影子 微笑的时候拨动头发的样子 ——,当你发现以上的文...
    小雷微凝国际阅读 3,624评论 0 1

友情链接更多精彩内容