iOS开发代码规范

1、命名规范

1.1 统一要求

含义清楚，尽量添加注释，使用全称，不使用缩写

1.2 类的命名

大驼峰式命名：每个单词的首字母都采用大写字母

例如：
MyPageViewController      //ViewController: 使用ViewController做后缀
MyPageView                //View:使用View做后缀
MyPageTableViewCell       //UITableViewCell:使用TableViewCell做后缀
MyPageCollectionViewCell  //UICollectionViewCell 使用CollectionViewCell做后缀
MyPageDelegate            //Protocol: 使用Delegate或者DataSource作为后缀

1.3 私有变量

小驼峰式命名：第一个单词以小写字母开始，后面的单词的首字母全部大写，不要使用拼音，也不要使用字母缩写

例如：firstName、lastName

1.4 property变量

小驼峰式命名，不要使用拼音，也不要使用字母缩写

例如： //注释
@property (nonatomic, copy) NSString *userName;

1.5 宏命名

全部大写，单词间用 _ 分隔。[不带参数]

例子: #define THIS_IS_AN_MACRO @"THIS_IS_AN_MACRO"

以字母 k 开头，后面遵循大驼峰命名。[不带参数]

  例子：#define kWidth          self.frame.size.width

小驼峰命名。[带参数]

  #define getImageUrl(url) [NSURL URLWithString:[NSString stringWithFormat:@"%@%@",kBaseUrl,url]]

1.6 Enum

Enum类型的命名与类的命名规则一致
Enum中枚举内容的命名需要以该Enum类型名称开头

例子:
  typedef NS_ENUM(NSInteger, AFNetworkReachabilityStatus) {
      AFNetworkReachabilityStatusUnknown = -1,
      AFNetworkReachabilityStatusNotReachable = 0,
      AFNetworkReachabilityStatusReachableViaWWAN = 1,
      AFNetworkReachabilityStatusReachableViaWiFi = 2
  };

1.7 For-In & For 规范

例如：
for (NSInteger i = 0; i < 10; i++) {

    // code body
}

NSArray *numberArray = @[@1, @2, @3, @4, @5 , @6, @7, @8, @9];
for (id number in numberArray) {

    NSLog(@"%@", number);
}

1.8 Block规范

在函数中使用到Block时, 与if-else或者for-in不太一样, Block第一行与代码块必须得空行, 无论方法是否是系统自带的

例如：
[className blockName:^(parameter) {

    // Code Body
}];

1.9 运算符规范

例如：
BOOL isOpen  = true;
BOOL isClose = !isOpen；
self.myString = @“mySring”
NSInteger userAge = @"Man" ? 18 : 19;  //双目运算符

1.10 If-else规范

例如：
- (instancetype)initWithFrame:(CGRect)frame {

    if (self = [super initWithFrame:frame]) {
        // code body
    }
    return self;
}

if (age < 0) {

        // Code Body        
}

2、注释

2.1 属性注释

例如：
//学生
@property (nonatomic, strong) Student *student;

2.2 方法声明注释

/** 
* @brief 登录验证
*
* @param personId 用户名
* @param password 密码
* @param complete 执行完毕的block
*
* @return
*/
+ (void)loginWithPersonId:(NSString *)personId password:(NSString *)password complete:(void (^)(CheckLogon *result))complete;

2.3 .m中方法注释

#pragma mark ------------------------------- Some Mothed

3、格式化代码

3.1 指针 "*" 位置

定义一个对象时，指针 "*" 靠近变量

例如: NSString *userName;

3.2 方法的声明和定义

在- 、+和返回值之间留一个空格，方法名和第一个参数之间不留空格

例如：
- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section

3.3 方法和方法之间空一行，大括号跟在方法名后边（个人习惯，苹果官方给的是另起一行）

例如：
- (void)method1  {

}

- (void)method2 {

}

3.4 方法内部大括号

例如：
- (void)method  {

     BOOL isFirst = YES;
      if(isFirst) {
          // do something here
     }
}

最后编辑于：2019.01.08 14:00:06