美文网首页
代码规范

代码规范

作者: 会飞的大马猴 | 来源:发表于2017-02-21 15:50 被阅读34次

代码规范

方法的声明和定义

代码块

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

mrak快速查找代码

pragma mark - UITableViewDelegate

命名
类名(及其category name 和 protocal name)的首字母大写,写使用首字母大写的形式
分割单词
在面向多应用的代码中,推荐使用前缀。如:BFSendMessage

相关文章

  • Web 端代码规范

    目录 1、代码规范概述 2、代码规范流程搭建 3、代码规范细则 1、代码规范概述 良好的代码规范能够提供软件的可读...

  • 代码规范

    代码规范 1. 概述 欢迎使用前端代码规范, 这里借鉴、引用的是京东前端代码规范。 遵循代码规范的目的在于增强团队...

  • iOS 代码规范篇

    iOS 代码规范篇 iOS 代码规范篇

  • iOS(OC)开发之随感

    1.代码规范 规范很重要!规范很重要!规范很重要! 代码规范的重要性之-为什么谷歌要执行严格的代码编写规范http...

  • 前端学习的基本总结

    目录 1.为什要遵守代码规范 2.css代码规范 3.js代码规范与设计模式3.1 js代码规范3.2 设计模式 ...

  • 乐乎项目优化

    编程: 1、代码规范。架构规范、文件组织规范、命名规范、代码逻辑规范、资源存放。 一、使用cocoapod 二、代...

  • 小肤iOS开发代码规范_v1.0

    For Objective-C , 2018.8.2 Ⅰ.前言Ⅱ.命名规范Ⅲ.代码注释规范Ⅳ.代码格式化规范Ⅴ....

  • 代码规范

    代码规范 1. 概述 欢迎使用代码规范, 这个是我借鉴京东前端代码规范,组织的内部规范。旨在增强团队开发协作、提高...

  • PSR-2- Coding Style Guide 编码风格规范

    代码风格规范 本篇规范是 PSR-1 基本代码规范的继承与扩展。 本规范希望通过制定一系列规范化PHP代码的规则,...

  • PM篇

    PM 技术篇1.开发规范命名规范,异常处理规范,日志规范,统一框架,代码commit规范,代码评审规范,统一API...

网友评论

      本文标题:代码规范

      本文链接:https://www.haomeiwen.com/subject/dejuwttx.html