代码规范

最新推荐文章于 2024-06-17 18:03:48 发布

YouAirBlue

最新推荐文章于 2024-06-17 18:03:48 发布

阅读量230

点赞数

分类专栏： iOS

本文链接：https://blog.csdn.net/CJB568592503/article/details/73523118

版权

iOS 专栏收录该内容

3 篇文章 0 订阅

订阅专栏

代码组织

对内存的合理，controller，view的生命周期函数放到最上面，自己实现的方法在下面，相同/相近功能的方法采用#pragma mark -来标记

这样做的好处就是能快比较快速得定位到你要查找的代码段

pragma mark - Lifecycle  
- (instancetype)init {}  
- (void)dealloc {}  
- (void)viewDidLoad {}  
- (void)viewWillAppear:(BOOL)animated {}  
(void)didReceiveMemoryWarning {}  

pragma mark - Custom Accessors  
- (void)setCustomProperty:(id)value {}  
(id)customProperty {}  

pragma mark - IBActions  
(IBAction)submitData:(id)sender {}  

pragma mark - Public  
(void)publicMethod {}  

pragma mark - Private  
(void)privateMethod {}  

pragma mark - UITextFieldDelegate  

pragma mark - UITableViewDataSource  

pragma mark - UITableViewDelegate  

pragma mark - NSCopying  
(id)copyWithZone:(NSZone *)zone {}  

pragma mark - NSObject  
(NSString *)description {}

条件语句

应该：

if (user.isHappy) {  
    //Do something  
} else {  
    //Do something else  
}


if (!error) {  
  return success;  
}

不应该：

if (user.isHappy)  
{  
  //Do something  
}  
else {  
  //Do something else  
}  


if (!error)  
  return success;

命名

类和常量的命名应当使用前缀

比如：

UIViewController
static NSTimeInterval const RWTTutorialViewControllerAnimationDuration = 0.3;

UIViewController 后缀添加“ViewController”
UIView 后缀添加“View”
UIButton 后缀添加“Button”
UILabel 后缀添加“Label”

block

应该：

// blocks are easily readable  
[UIView animateWithDuration:1.0 animations:^{  
  // something  
} completion:^(BOOL finished) {  
  // something  
}];

不应该：

// colon-aligning makes the block indentation hard to read  
[UIView animateWithDuration:1.0  
                 animations:^{  
                     // something  
                 }  
                 completion:^(BOOL finished) {  
                     // something  
                 }];

注释

当需要注释时，注释应该用来解释这段特殊代码为什么要这样做。任何被使用的注释都必须保持最新或被删除。

一般都避免使用块注释。生成文档的注释除外

对生成文件，方法，属性的注释
推荐使用 VVDocumenter

使用效果：

/**
 *  获取产品列别
 *
 *  @param requestTag  请求标签
 *  @param finishBlock 请求结束处理，如果传出的数据为nil，就表示获取失败
 */
- (void)getProductTypeWithRequestTag:(int)requestTag finishBlock:(netRequestResultBlock)finishBlock{
}

方法命名规范


- (void)setExampleText:(NSString *)text image:(UIImage *)image;  
- (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;  
- (id)viewWithTag:(NSInteger)tag;  
- (instancetype)initWithWidth:(CGFloat)width height:(CGFloat)height;

标题书写规范

//
//  FINetWorkManager.m
//  StudyClound
//
//  Created by 陈江彬 on 6/3/15.
//  Copyright (c) 2015 StudyClound. All rights reserved.
//
                     空1行
#import "FILoginViewController.h"
#import "AppDelegate.h"
                     空1行
@interface FINetWorkManager(){
                     空1行
    ANReachability *wifiReach;
    ANReachability *internetReach;
}
                     空1行
@property (nonatomic, strong) NSMutableArray *requestListArray;
                     空1行
@end
                     空1行
                     空1行
@implementation FINetWorkManager

变量

NSString text 既不是 NSString text 也不是 NSString * text

声明NSArray，NSDictionary，NSString这些属性一般使用copy，很少用strong，copy是复制一份新的，然后内存地址也就跟着变了，strong内存地址是不变的，如果此时A对象是从B对象赋值过来的，如果用了strong，B对象一旦改变，A对象的值也会跟着改变。用copy的话就不会出现这样子的情况。所以要分清楚情况。

@property (copy, nonatomic) NSString *tutorialName;
@property (copy, nonatomic) NSArray *array;
@property (copy,nonatomic) NSDictionary *dictionary;

字面值

NSString、NSDictionary、NSArray和NSNumber的字面值应该在创建这些类的不可变实例时被使用。请特别注意nil值不能传入NSArray和NSDictionary字面值，因为这样会导致crash。

应该：

NSArray *names = @[@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul"];  
NSDictionary *productManagers = @{@"iPhone": @"Kate", @"iPad": @"Kamal", @"Mobile Web": @"Bill"};  
NSNumber *shouldUseLiterals = @YES;  
NSNumber *buildingStreetNumber = @10018;

不应该：

NSArray *names = [NSArray arrayWithObjects:@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul", nil];  
NSDictionary *productManagers = [NSDictionary dictionaryWithObjectsAndKeys: @"Kate", @"iPhone", @"Kamal", @"iPad", @"Bill", @"Mobile Web", nil];  
NSNumber *shouldUseLiterals = [NSNumber numberWithBool:YES];  
NSNumber *buildingStreetNumber = [NSNumber numberWithInteger:10018];

常量

常量应该使用static来声明而不是使用#define，除非显式地使用宏

应该：

static NSString * const RWTAboutViewControllerCompanyName = @"RayWenderlich.com";  

static CGFloat const RWTImageThumbnailHeight = 50.0;

不应该：

#define CompanyName @"RayWenderlich.com"  
#define thumbnailHeight 2

枚举类型

typedef NS_ENUM(NSInteger, RWTLeftMenuTopItemType) {  
  RWTLeftMenuTopItemMain,  
  RWTLeftMenuTopItemShows,  
  RWTLeftMenuTopItemSchedule  
};  


typedef NS_ENUM (NSInteger,RunGoalTypeE){

    kRunGoalTypeNone       = 0,    //无目标

    kRunGoalTypeTime       = 1,    //以时间为目标

    kRunGoalTypeDistance   = 2,    //以距离为目标

    kRunGoalTypeCalori     = 3,    //以消耗卡路里为目标

};

类构造方法

使用instancetype，而不是id

@interface Airplane  
+ (instancetype)airplaneWithType:(RWTAirplaneType)type;  
@end

黄金路径

当使用条件语句编码时，左手边的代码应该是”golden” 或 “happy”路径。
也就是不要嵌套if语句。

应该：

- (void)someMethod {  
  if (![someOther boolValue]) {  
    return;  
  }  
  //Do something important  
}

不应该：

- (void)someMethod {  
  if ([someOther boolValue]) {  
    //Do something important  
  }  
}

单例

单例对象应该使用线程安全模式来创建共享实例。

+ (instancetype)sharedInstance {  
  static id sharedInstance = nil;  
  static dispatch_once_t onceToken;  
  dispatch_once(&onceToken, ^{  
    sharedInstance = [[self alloc] init];  
  });  
  return sharedInstance;  
}

换行符


self.productsRequest = [[SKProductsRequest alloc] initWithProductIdentifiers:productIdentifiers product:productName price:price];


一行很长的代码应该分成多行代码。

self.productsRequest = [[SKProductsRequest alloc]
  initWithProductIdentifiers:productIdentifiers
                              product:productName
                                  price:price];