注释

必需：类介绍/方法介绍/属性介绍

• 类的注释写在当前类文件的顶部
• 对于属性的注释建议写在属性上面，用的时候，会有提示功能

/// 刷新按钮
@property (nonatomic, strong) UIButton *refreshBtn;

• 对于 .h 文件中方法的注释，一律按快捷键 command+option+/。三个快捷键解决。按需在旁边对方法进行说明解释、返回值、参数的说明和解释
  对于.m文件中方法的注释，在方法的上边或右边添加//，注释符和注释内容需要间隔一个空格

// load network data

• 功能注释
  版本迭代中，在同事写的代码基础上开发，一定要写上版本功能注释，方便询问具体功能

// 这是一个新加的功能 v5.20.0 by hj  2019-03-20 18:00

方法

• 方法与方法之间间隔一行
• 方法最后面的括号需要另起一行。遵循 Apple 的规范；对于其他场景的括号，括号不需要单独换行。比如 if 后面的括号

- (instancetype)init
{
    self = [super init];
    if (self) {
        <#statements#>
    }
    return self;
}

• 如果方法参数过多过长，建议多行书写。用冒号进行对齐

- (void)doHomework:(NSString *)name
            period:(NSInteger)second
            score:(NSInteger)score;

• 一个方法内的代码最好保持在50行以内，一般经验来看如果一个方法里面的代码行数过多，代码的阅读体验就很差（别问为什么，做过重构代码行数很长的人都有类似的心情）
• 一个函数只做一个事情，做到单一原则。所有的类、方法设计好后就可以类似搭积木一样实现一个系统
• 对于有返回值的函数，且函数内有分支情况。确保每个分支都有返回值
• 函数如果有多个参数，外部传入的参数需要检验参数的非空、数据类型的合法性，参数错误做一些措施：立即返回、断言
• 多个函数如果有逻辑重复的代码，建议将重复的部分抽取出来，成为独立的函数进行调用
• 方法如果有多个参数的情况下需要注意是否需要介词和连词。很多时候在不知道如何抉择测时候思考下苹果的一些 API 的方法命名

//good
- (instancetype)initWithAge:(NSInteger)age name:(NSString *)name;
- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath;

//bad
- (instancetype)initWithAge:(NSInteger)age andName:(NSString *)name;
- (void)tableView:(UITableView *)tableView :(NSIndexPath *)indexPath;

• 控制器的方法分类及顺序规范

#pragma mark - Initializatio
#pragma mark - Life cycle
#pragma mark - Actions
// view的⼀一些事件⽐比如按钮点击、⼿手势事件处理理、通知处理理
#pragma mark - Delegates // 实现遵循的代理理⽅方法
#pragma mark - Private method // 控制器器的⼀一些私有的辅助⽅方法
#pragma mark - Getter & Setter // 属性的Getter/Setter⽅方法

属性

• 对外尽量使用不可变对象：尽量把对外公布出来的属性设置为只读，在实现文件内部设为读写。具体做法是：
  在头文件中，设置对象属性为readonly。在实现文件中设置为readwrite
• 属性应该尽可能描述性地命名，避免缩写，并且是小写字母开头的驼峰命名

变量名

• 做到⻅名知意
• 一个变量有且只有一个功能，尽量不要把一个变量用作多种用途
• 变量的名称必须同时包含功能与类型

• 系统常用类作实例变量声明时加入后缀

  
  4F980E0F-6C4E-4D27-BB3E-CBF95EB01E88.png

条件表达式

• 当有条件过多、过长的时候需要换行，为了代码看起来整齐些

//good
if (condition1() && 
    condition2() && 
    condition3() && 
    condition4()) {
  // Do something
}
//bad
if (condition1() && condition2() && condition3() && condition4(）) { ... }

• 在一个代码块里面有个可能的情况时善于使用 return 来结束异常的情况

- (void)doHomework
{
    if (self.hungry) {
        return;
    }
    if (self.thirsty) {
        return;
    }
    if (self.tired) {
        return;
    }
}

• 每个分支的实现都必须使用 {} 包含

// bad
if (self.hungry) self.eat() 

// good
if (self.hungry) {
    self.eat()
}

• 条件判断的时候应该是变量在左，条件在右。

if ( currentCursor == 2 ) { ... }

• switch 语句后面的每个分支都需要用大括号括起来
• switch 语句后面的 default 分支必须存在，除非是在对枚举进行 switch

switch (menuType) {  
  case menuTypeLeft: {
    // ...  
    break; 
   }
  case menuTypeRight: {
    // ...  
    break; 
  }
  case menuTypeTop: {
    // ...  
    break; 
  }
  case menuTypeBottom: {
    // ...  
    break; 
  }
}

宏定义

• 尽量量少⽤用宏来定义具体类型的数据，可以改⽤用static NSString* const kMsg = @”MSG”等来表示
• 字⺟全大写，单词与单词之间用_分割
• 采⽤用驼峰法命名(首字母大写)

#define HOME_PAGE_DID_SCROLL @"com.xq.home.page.tableview.did.scroll"
#define KHomePageDidScroll @"com.xq.home.page.tableview.did.scroll"

图片资源命名

• 单个文件的命名
  1.文件资源的命名也需要一定的规范
  2.命名规范：不能有中文、大写、特殊符号、空白
  3.形式为：功能模块名类别功能状态@nx.png
  Setting_Button_search_selected@2x.png
  Setting_Button_search_unselected@2x.png
  3.万能公式：类别功能模块页面名称状态.png
  icon_tab_bookshelf_sel@2x.png
• 资源的文件夹命名
  最好也参考 App 按照功能模块建立对应的实体文件夹目录，最后到对应的目录下添加相应的资源文件

组件版本规范

采用 A.B.C 三位数字命名，比如：1.0.2，当有更新的情况下按照下面的依据

版本号	右说明对齐标题	示例
A.b.c	属于重大内容的更新	1.0.2 -> 2.0.0
a.B.c	属于小部分内容的更新	1.0.2 -> 1.1.1
a.b.C	属于补丁更新	1.0.2 -> 1.0.3

注意事项

• 使⽤用block时，如果block被单例例持有，则block内的self应使⽤用弱引⽤用
• 函数（方法）块之间使用一个空行分隔
• 对输入参数的正确性和有效性进行检查
• 一元运算符与变量之间没有空格

!aValue
-aValue  //负号
~aValue  //位非
++iCount
*strSource

其他

Xcode 代码块的存放地址
~/Library/Developer/Xcode/UserData/CodeSnippets 
Xcode文件模版的存放地址
/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/Library/Xcode/Templates/File Templates/