OC代码规范

OC代码规范

一、代码格式

1.1、使用空格而不是制表符Tab

不要在工程里使用 Tab 键，使用空格来进行缩进。在 Xcode > Preferences > Text Editing 将 Tab 和自动缩进都设置为 4 个空格，因为在不同的编码环境中，Tab键所设置的空格也会不一样，比如有的是 2 个和 4 个空格。

1.2、每一行的最大长度

同样的，在 Xcode > Preferences > Text Editing > Page guide at column: 中将最大行长设置为 80 ，过长的一行代码将会导致可读性问题

1.3、函数的书写

一个典型的 Objective-C 函数应该是这样的：

- (void)writeVideoFrameWithData:(NSData *)frameData timeStamp:(int)timeStamp {

...

}

在 - 和 (void) 之间应该有一个空格，第一个大括号 { 的位置在函数所在行的末尾，同样应该有一个空格。

如果一个函数有特别多的参数或者名称很长，应该将其按照:来对齐分行显示：

-(id)initWithModel:(IPCModle)model

ConnectType:(IPCConnectType)connectType

Resolution:(IPCResolution)resolution

AuthName:(NSString *)authName

Password:(NSString *)password

MAC:(NSString *)mac

AzIp:(NSString *)az_ip

AzDns:(NSString *)az_dns

Token:(NSString *)token

Email:(NSString *)email

Delegate:      (id<IPCConnectHandlerDelegate>)delegate;

1.4函数调用

函数调用的格式和书写差不多，可以按照函数的长短来选择写在一行或者分成多行：

//写在一行

[myObject doFooWith:arg1 name:arg2 error:arg3];

//分行写，按照 : 对齐

[myObject doFooWith:arg1

name:arg2

error:arg3];

以下写法是错误的：

//错误，要么写在一行，要么全部分行

[myObject doFooWith:arg1 name:arg2

error:arg3];

[myObject doFooWith:arg1

name:arg2 error:arg3];

//错误，按照首字母来对齐。

[myObject doFooWith:arg1

name:arg2

error:arg3];

1.5、@public和@private标记符

@public和@private标记符应该以一个空格来进行缩进：

@interface MyClass : NSObject {

@public

...

@private

...

}

@end

1.6、if，else，for应独占一行

if (writeToFile) {

writeFileThread.interrupt(); }

if (j > 0 && j < 10) { ... // program code } else if (j >= 10 && j < 20) { ... // program code } else { ... // program code }

1.7、 不允许把多个短语句写在一行中，即一行只写一条语句。

//错误

titleButton.width = 150; titleButton.height = 30;

//正确

titleButton.width = 150;

titleButton.height = 30;

二、命名规范

基本原则

2.1 清晰

命名应该尽可能的清晰和简洁，但在Objective-C中，清晰比简洁更重要。Xcode会自动寻找类似的方法

2.2、一致性

在同一个模块下或者派生类的时候，要遵循其基类或整体模块的命名风格，保持命名风格一致性

2.3、使用前缀

在命名某个类的时候应加上公司的前缀，在必要的时候可以加上个人的名字缩写。

2.4、命名方法

我们在方法命名时候，尽可能的把方法详细的描述，便于自己或他人review。所以一般采用驼峰命名，而且都采用英文，千万不要用拼音。。。

- (void)getImage {

...

}

2.5、命名代理

最标准的就是参照苹果写的代理方法

- (BOOL)tableView:(NSTableView *)tableView shouldSelectRow:(int)row;

2.6、 命名属性

属性的第一个字母小写，后续单词首字母大写。

//名词属性

@property (nonatomic, strong) NSString *title;

//动词属性

@property (nonatomic, assign) BOOL showsAlpha;

2.7、 命名变量

左右空格

int a = 5 ;

double b = 5.5 ;

2.8、 宏的命名

宏必须全部都为大写，并且用下划线分开

#define SCREEN_WIDTH 320.0

2.9、 枚举

枚举类型的命名规则和函数的命名规则相同

//定义一个枚举

typedef NS_ENUM(NSInteger, NSMatrixMode) {

NSRadioModeMatrix,

NSHighlightModeMatrix,

NSListModeMatrix,

NSTrackModeMatrix

};

三、注释

我们有写注释的习惯，因为很多代码我们要经常维护，所以有注释维护代码的效率会大大的提高

3.1、代码注释

方法、函数、类、协议、类别的定义都需要注释，苹果很多API都有注释，它能让我们更好的知道该方法的用途、功能，和如何实现的。

@property (nonatomic, readonly, strong, nullable)

UILabel *textLabel NS_AVAILABLE_IOS(3_0);

// default is nil.  label will be created if

necessary.

协议、委托的注释要明确说明其被触发的条件

/** Delegate - Sent when failed to init connection, like p2p failed. */

-(void)initConnectionDidFailed:(IPCConnectHandler *)handler;

3.2、 文件注释

每一个文件都必须写文件注释，文件注释通常包含

文件所在模块

作者信息

历史版本信息

版权信息

文件包含的内容，作用

参考项目刚创建的时候

四、编码风格

4.1 尽可能不要用new方法

很多人用new代替alloc init，有时候内存会有问题。苹果大多数都用alloc init，我们尽可能跟着苹果的风格走。

五、个人建议

5.1 Delegate要使用弱引用

代理使用weak，不要用strong，容易循环引用

5.2 @class

在.h文件中尽量少引用某个类，一般我们只需要知道有这个类就可以了，所以我们都会用@class，因为用#import编译器还会去编译那个类

5.3 尽量使用self而不是下划线

使用self可以触发setter和getter，还可以区分成员变量

5.4 属性暴露

定义属性时候，如果其他类不会用到，尽可能写在.m文件中，这样不会暴露属性

5.5 封装

封装是OC的三大特征之一，我们尽可能的把一个方法或者一个类封装，这样可以更好的提高开发效率。

5.6 MVC

在编码过程中，我们必须采用MVC这种设计模式，必要的时候会采取MVVM。

5.7 设计模式的选择

OC有20多种设计模式，能用代理尽量不要用通知，能用Block最好，单例视情况而定，因为单例会独占一块内存

5.8 文件的存放

一般我们会采用MVC，所以控制器放在C，模型放在M，一些视图放在V。

5.9 引用框架的根头文件

每一个框架都会有一个和框架同名的头文件，它包含了框架内接口的所有引用，在使用框架的时候，应该直接引用这个根头文件，而不是其它子模块的头文件

//正确，引用根头文件

#import "Foundation/Foundation.h"

//错误，不要单独引用框架内的其它头文件

#import "Foundation/NSArray.h"

#import "Foundation/NSString.h"