IOS 编程风格及命名规范
目的
统一规范Xcode编辑环境下 Object-C 的编程风格和标准，尽量遵循苹果公司发布代码中的主流代码风格。
Xcode 一般工程目录结构
-
例:
CarPurifier -README.md -CarPurifier --CarPurifierApi --Resources --Macro --General --Helpers --Models --Sections ---UserInfomationVCtrl . . --Vendors --Utility --Services . . . Pods -Podfile . .
文件及模块命名及结构管理
文件夹及文件创建 相应字母必须大写. 例: UserInfomationVCtrl。
禁止在项目中的任何地方，包括文件名、目录名、逻辑目录名、项目名，使用空格或中文字符。
资源文件plist，image，audio，video，buddle等相关资源 一律放入Resources文件夹，并建立对应文件夹.如有其他特殊情况，在相关文件下 做好备注。
第三方的类库/SDK，如UMeng、WeiboSDK、WeixinSDK及相关第三方开源库 等专门存放在固定文件夹Vendors中，每个第三方库应该有属于自己的文件夹
自定义公用类 放入 General 文件夹 命名方式 例：ADMainButton，ADWalkthroughTextField，AD代表阿迪的首字母表示 构建者
项目APP公用定义 如枚举、消息通知、宏 放入 Macro文件夹
备注:其他根据项目需求而定
书写规范
Xcode 工程
物理文件应该与Xcode工程文件保持同步来避免文件扩张。任何Xcode分组的创建应该在文件系统的文件体现。代码不仅是根据类型来分组，而且还可以根据功能来分组，这样代码更加清晰。
尽可能在target的Build Settings打开”Treat Warnings as Errors，和启用以下additional warnings。如果你需要忽略特殊的警告，使用Clang’s pragma feature。
代码组织
在函数分组和protocol/delegate实现中使用#pragma mark -来分类方法，要遵循以下一般结构：
#pramma 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 - Protocol conformance
#pragma mark - UITextFieldDelegate
#pragma mark - UITableViewDataSource
#pragma mark - UITableViewDelegate
#pragma mark - NSCopying
- (id)copyWithZone:(NSZone *)zone {}
#pragma mark - NSObject
- (NSString *)description {}
Whitespace
对齐方式 就按 Xcode 默认缩进方式吧
- 包含 依赖文件的时候，最好 分清晰
///系统框架
#import <Foundation/Foundation.h>
#import <StoreKit/StoreKit.h>
///pods
#import <AFNetworking/AFNetworking.h>
///
#import "SomeDependency.h"
#import "SomeOtherDependency.h"
@interface UserLoginCtrl ()
括号
- 方法大括号和其他大括号(if/else/switch/while 等.)总是在同一行语句打开但在新行中关闭
建议写法
if(condition){
///do something
}
else{
///do something
}
不建议写法
if(condition)
{
///do something
}
else
{
///do something
}
注释
建议写法
/**
@brief 方法或变量名说明
@param 参数1说明
@param 参数2说明
…
@return 若方法又返回值则对返回值作说明
*/
+ (NSString *)uuid:(NSString *)param;
///用户名
@property (nonatomic, strong) ADWalkthroughTextField *usernameField;
///头像 图标
@property (nonatomic, strong) UIImageView *headIcon;
或者
/*
* 密码
*/
@property (nonatomic, strong) UITextField *passwordField;
- 备注: xcode 注释插件 https://github.com/onevcat/VVDocumenter-Xcode
命名
命名尽量简洁,但不能因为简洁而使命名难以理解
建议写法
UIButton *settingButton;
UILabel *titleLabel;
UITextField *detailTextField;
UITextView *valueTextView;
不建议写法
UIButton *settingBtn; 或者 UIButton *settingBut;
UILabel *titleLbl; 或者 UIButton *titleLab;
UITextField *detailField;
UITextView *valueTView;
常量命名规则（驼峰式命名规则），所有的单词首字母大写和加上与类名有关的前缀:
建议写法
CGFloat const GeneralWalkthroughStandardOffset = 15.0;
static CGFloat const GeneralWalkthroughSecondaryButtonHeight = 33.0;
NSTimeInterval const GeneralWalkthroughAnimationDuration = 0.3f;
UIEdgeInsets const CreateAccountBackButtonPadding = {1.0, 0.0, 0.0, 0.0};
不建议写法
CGFloat const tandardOffset = 15.0;
static CGFloat const ButtonHeight = 33.0;
NSTimeInterval const Duration = 0.3f;
属性也是使用驼峰式，但首单词的首字母小写:
@property (strong, nonatomic) NSString *descriptiveVariableName;
或者 @property (copy, nonatomic) NSString *descriptiveVariableName;
-
注：属性的声明和实现，尽量避免书写@synthesize，如果用到@synthesize，要紧接着@implementation书写，不要空行
-
当使用属性时，实例变量应该使用self.来访问和改变。这就意味着所有属性将会视觉效果不同，因为它们前面都有self.。
但有一个特例：在初始化方法里，实例变量(例如，_variableName)应该直接被使用来避免getters/setters潜在的副作用。
局部变量不应该包含下划线。 -
成员变量尽量写在@implementation内部，有必要对外暴露时(或者 .m 中@interface)，才写在@interface下
-
对于声明 NSString的属性，还是用 copy 特性，原因度娘 谷歌。
方法
写方法的风格 例如 Apple 的风格： - (void)addSubview:(UIView *)view;
建议写法
- (NSString *)name;
- (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;
不建议写法
- (NSString *)getName;
- (void)setT:(NSString *)text i:(UIImage *)image;
- (void)sendAction:(SEL)aSelector :(id)anObject :(BOOL)flag;
- (id)taggedView:(NSInteger)tag;
- (instancetype)initWithWidth:(CGFloat)width andHeight:(CGFloat)height;
- (instancetype)initWith:(int)width and:(int)height; // Never do this.
点语法
修改属性 : setter 和 getter
Apple文档:
建议写法
NSInteger arrayCount = [self.array count];
view.backgroundColor = [UIColor orangeColor];
[UIApplication sharedApplication].delegate;
不建议写法
NSInteger arrayCount = self.array.count;
[view setBackgroundColor:[UIColor orangeColor]];
UIApplication.sharedApplication.delegate;
简写
NSDictionary、NSArray和NSNumber 的简写
建议写法
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];
常量定义
建议写法
局部 定义（当前文件）
CGFloat const CreateAccountIOS7StatusBarOffset = 20.0;
NSString *const UMAPP_KEY =@"55d3de82e0f55a54fd004dad";
全局 定义（重复使用）
static CGFloat const CreateAccountIOS7StatusBarOffset = 20.0;
static NSString *const UMAPP_KEY =@"55d3de82e0f55a54fd004dad";
不建议写法
#define CreateAccountIOS7StatusBarOffset 20.0;
#define UMAPP_KEY @"55d3de82e0f55a54fd004dad"
枚举类型 定义
当使用enum时，推荐使用新的固定基本类型规格，因为它有更强的类型检查和代码补全
建议写法
typedef NS_ENUM(NSInteger, MBProgressHUDAnimation) {
/** Opacity animation */
MBProgressHUDAnimationFade,
/** Opacity + scale animation */
MBProgressHUDAnimationZoom,
MBProgressHUDAnimationZoomOut = MBProgressHUDAnimationZoom,
MBProgressHUDAnimationZoomIn
};
或者
typedef NS_OPTIONS(NSUInteger, UIViewAutoresizing) {
UIViewAutoresizingNone = 0,
UIViewAutoresizingFlexibleLeftMargin = 1 << 0,
UIViewAutoresizingFlexibleWidth = 1 << 1,
UIViewAutoresizingFlexibleRightMargin = 1 << 2,
UIViewAutoresizingFlexibleTopMargin = 1 << 3,
UIViewAutoresizingFlexibleHeight = 1 << 4,
UIViewAutoresizingFlexibleBottomMargin = 1 << 5
};
或者
typedef NS_ENUM(NSInteger, RWTGlobalConstants) {
RWTPinSizeMin = 1,
RWTPinSizeMax = 5,
RWTPinCountMin = 100,
RWTPinCountMax = 500,
};
-
注: 当用到 CoreFoundation C code 或者 C++ code 时，可以使用
enum GlobalConstants { kMaxPinSize = 5, kMaxPinCount = 500; };
条件判断
BOOL类型: Objective-C使用YES和NO。因为true和false应该只在CoreFoundation，C或C++代码使用。既然nil解析成NO，所以没有必要在条件语句比较。不要拿某样东西直接与YES比较，因为YES被定义为1和一个BOOL能被设置为8位。
建议写法:
if(isBool){
/// do something
}
if(![String isEqualToString:@"string" ]){
/// do something
}
-
注: 如果BOOL属性的名字是一个形容词，属性就能忽略”is”前缀，但要指定get访问器的惯用名称
@property (assign, getter=isEditable) BOOL editable;
Object 类型: 当判断为nil 时
建议写法
if(object == nil){
/// do something
}
不建议写法
if(object){
/// do something
}
判端 delegate 是否存在时
建议写法
if([self.delegate conformsToProtocol:@protocol(RESideMenuDelegate)] &&
[self.delegate respondsToSelector:@selector(sideMenu:willShowMenuViewController:)){
/// do something
}
不建议写法
if(delegate){
/// do something
}
- 当条件只中带有 return 时
建议写法
if (!error) {
return success;
}
不建议写法
if (!error)
return success;
或者
if (!error) return success;
三元操作符
当需要提高代码的清晰性和简洁性时，三元操作符?:才会使用。单个条件求值常常需要它。多个条件求值时，如果使用if语句或重构成实例变量时，代码会更加易读。一般来说，最好使用三元操作符是在根据条件来赋值的情况下。
Non-boolean的变量与某东西比较，加上括号()会提高可读性。如果被比较的变量是boolean类型，那么就不需要括号。
建议写法
NSInteger value = 5;
result = (value != 0) ? x : y;
BOOL isHorizontal = YES;
result = isHorizontal ? x : y;
不建议写法
result = a > b ? x = c > d ? c : d : y;
Init方法
Init方法应该遵循Apple生成代码模板的命名规则，返回类型应该使用instancetype而不是id。
- (instancetype)init {
self = [super init];
if (self) {
// ...
}
return self;
}
类构造方法
同 Init 方法
@interface Airplane
+ (instancetype)initWithType:(ADViewTpye)type
- (instancetype)initWithLeftViewImage:(UIImage *)image;
@end
- 注: 可以看看 http://NSHipster.com
Dealloc Methods
Dealloc 方法在ARC 下 已经不再需要，但在某些情况下必须使用以除去observers，KVO等
- (void)dealloc{
[[NSNotificationCenter defaultCenter] removeObserver:self];
}
CGRect函数
当访问CGRect里的x, y, width, 或 height时，应该使用CGGeometry函数而不是直接通过结构体来访问。引用Apple的CGGeometry：
- 在这个参考文档中所有的函数，接受CGRect结构体作为输入，在计算它们结果时隐式地标准化这些rectangles。因此，你的应用程序应该避免直接访问和修改保存在CGRect数据结构中的数据。相反，使用这些函数来操纵rectangles和获取它们的特性。
建议写法
CGRect frame = self.view.frame;
CGFloat x = CGRectGetMinX(frame);
CGFloat y = CGRectGetMinY(frame);
CGFloat width = CGRectGetWidth(frame);
CGFloat height = CGRectGetHeight(frame);
CGRect frame = CGRectMake(0.0, 0.0, width, height);
建议写法
CGRect frame = self.view.frame;
CGFloat x = frame.origin.x;
CGFloat y = frame.origin.y;
CGFloat width = frame.size.width;
CGFloat height = frame.size.height;
CGRect frame = (CGRect){ .origin = CGPointZero, .size = frame.size };
Golden Path
当使用条件语句编码时，左手边的代码应该是”golden” 或 “happy”路径。也就是不要嵌套if语句，多个返回语句也是OK。
建议写法
- (void)someMethod {
if (![someOther boolValue]) {
return;
}
//Do something important
}
Error handling
Singletons 单例
+ (instancetype)sharedInstance {
static id sharedInstance = nil;
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
sharedInstance = [[self alloc] init];
});
return sharedInstance;
}
