objective-c 编写规范_Objective-C编码规范

最新推荐文章于 2022-08-18 19:18:11 发布

weixin_39804523

最新推荐文章于 2022-08-18 19:18:11 发布

阅读量161

点赞数

文章标签： objective-c 编写规范

本文链接：https://blog.csdn.net/weixin_39804523/article/details/111757263

版权

本文详细介绍了Objective-C的编码规范，包括头文件和源文件的示例，强调了注释、命名规则、间距格式、方法声明与定义、属性类型等方面。建议遵守Apple & Google的规范，以提高代码可读性和一致性。

摘要由CSDN通过智能技术生成

本文参考Apple & Google Objective-C编码规范，根据个人的编码习惯，总结出一些通用的编码规则。

代码示例

头文件示例代码

下面是用Objective-C语言编写的规范的头文件示例代码。

//BTFoo.h//CodingGuidelines//

#import

/**

A sample class demonstrating good Objective-C style. All interfaces, categories, and protocols (read: all top-level declarations in a header) MUST be commented. Comments must alse be adjacent to the object they're documenting.*/

@protocolBTFooDelegate;@interfaceBTFoo : NSObject{@privateNSString*_bar;

CGFloat _price;@publicNSString*_name;id_delegate;

}

@property (nonatomic, copy) NSString*name; //the name of Foo. default is nil.

@property (nonatomic, assign) id delegate; //weak reference. default is nil.

/**

initializer. |string| will be copied and assigned to |_name|.

@param string The foo name.

@return an autorelease instance of BTFoo.*/

- (id)initWithString:(NSString *)string;/**

Designated initailizer. initialize a new BTFoo object.

@param name The model name.

@param number The model number.

@param price The model price.

@return a newly initialized object.*/

- (id)initFooWithModelName:(NSString *)name

modelNumber:(NSUInteger)number

modelPrice:(CGFloat)price;/**

Dosomething...

@param name The model name.

@param number The model number.

@param price The model price.*/

- (void)doName:(NSString *)name

modelNumber:(NSUInteger)number

modelPrice:(CGFloat)price;//Gets and Sets |_bar|.

- (NSString *)bar;- (void)setBar:(NSString *)bar;@end

源文件示例代码

下面是用Objective-C语言编写的规范的源文件示例代码。

//BTFoo.m//CodingGuidelines//

#import "BTFoo.h"

@interfaceBTFoo (PrivateMethods)+ (id)fooWithString:(NSString *)string;@end

@implementationBTFoo@synthesize name =_name;@synthesize delegate =_delegate;- (void)dealloc{

[_bar release];

[_name release];

[super dealloc];

}- (id)initWithString:(NSString *)string{

self=[super init];if(self) {

_name= [stringcopy];

_bar= [[NSString alloc] initWithFormat:@"bar"];

}returnself;

}- (id)initFooWithModelName:(NSString *)name

modelNumber:(NSUInteger)number

modelPrice:(CGFloat)price{

self=[BTFoo fooWithString:name];if(self) {

_price=price;

}returnself;

}- (void)doName:(NSString *)name

modelNumber:(NSUInteger)number

modelPrice:(CGFloat)price{

}- (NSString *)bar{return_bar;

}- (void)setBar:(NSString *)bar{

[_bar autorelease];

_bar=[bar copy];

}#pragma mark BTFoo Private Methods

+ (id)fooWithString:(NSString *)string{return [[[BTFoo alloc] initWithString:string] autorelease];

}- (void)doSomethingWith:(BTFoo *)theFoo

rect:(CGRect)theRect

interval:(float)theInterval{//...

}- (void)short:(BTFoo *)theFoo

longKeyword:(CGRect)theRect

evenLongerKeyword:(float)theInterval{//...

}@end

间距与格式

程序中代码的排版，缩进，间隔等可以根据IDE的具体设置而决定，但最终都应该使代码的间距与格式统一，达到整齐美观的效果。

指针的位置

类型与“*”之间一个空格，“*”与变量名之间没有空格。

NSString *_text;

每行代码的长度

每行代码的长度不超过100个字符。每行代码的字符数可通过IDE进行设置。(设置：XCode —> Preferences —> Text Editing —> Page guide at column : 100)

方法的声明与定义

声明方法时，在 - 或 + 与返回类型之间应该留一个空格的间距。参数表的参数之间不要留间隔。

星号(*)前的空格是必须的。

- (id)initWithString:(NSString *)string;

如果参数过多，每个参数应各占一行。在有多行参数的情况下，每行参数前的冒号应对齐。

- (void)doSomethingWith:(BTFoo *)theFoo

rect:(CGRect)theRect

interval:(float)theInterval{//...

}

当第一行的函数关键字比其后面行的关键字短时，后面的行应缩进四个空格。保证后续的关键字垂直对齐，而不应该采用冒号对齐的方式。

- (void)short:(BTFoo *)theFoo

longKeyword:(CGRect)theRect

evenLongerKeyword:(float)theInterval{//...

}

方法的调用

如果调用的方法没有超出一行(100字符长)，则所有参数在同一行。

[item1 setTitle:@"提交" forState:UIControlStateNormal];

如果调用的方法过长，则每个参数占用一行，以冒号对其。

[button addTarget:self

action:@selector(buttonPressed:)

forControlEvents:UIControlEventTouchUpInside];

如果调用的方法过长，但方法名比参数名短，每个参数一行，缩进四个空格竖直对齐。

[self short:myFoo

longKeyword:rect

eventLongerKeyword:10];

@public 与 @private的使用

使用权限控制符@public 和@private 应缩进两个空格。

@interfaceMyClass : NSObject{@privateNSInteger _count;@publicNSString*_title;

}@end

协议的使用

在类型标识符与协议的名之间不应该有空格。此协议使用的规范适用于类的声明、成员变量的声明以及方法的声明

@protocolMyClassDelegate;@interfaceMyClass : NSObject{@private

id_delegate;

}

@property (nonatomic, assign)id delegate;

如果申明中包含多个protocal且超出一行时换行，缩进两个空格。

@interface CustomViewController : UIViewController

UITextFieldDelegate, UISearchBarDelegate>{

}

@property,@synthesize,@dynamic的使用

@property与左括号之间留一个空格。

@property和@synthesize的缩进级别与@interface或者@implementation的缩进级别相同。

@property的声明语句应该紧跟在类的成员变量声明语句块的后面。

@synthesize的实现语句应该紧跟在@implementation语句之后。

@interface BTAppDelegate : UIResponder @property (strong, nonatomic) UIWindow*window;@end

@implementationBTAppDelegate@synthesize window = _window;

命名规范

文件的命名

文件的名字应该反映其中包含的类名字，也应该遵循项目的风格习惯。

文件扩展命的使用规范如下：

C/C++/Objective-C头文件

Objective-C源文件

.mm

Objective-C++源文件

.cc

纯C++源文件

C源文件

类的命名

类名应该用大写开头的驼峰命名法。

MyTableView、HomeViewController

在应用程序级别的代码中，尽量不要使用带前缀的类名。每个类都有相同的前缀不能提高可读性。如果是编写多个应用程序间的共用代码，那么需要为类名加上前缀。

Category的命名

Category的命名应该包含2-3个字符的前缀，用于说明Category是属于具体的某个工程的。

当声明一个Category时，Category的左括号与类名之间应该留一个空格的间隔。

例如要实现NSString的一个Category，用于实现解析功能。Category的文件名应该命名为NSString+GTMParsing.h，而Category的名字为GTMStringParsingAdditions，Category的名字与文件名不一致的原因是，在NSString+GTMParsing.h的文件中，可以声明多个用于解析功能的NSString类的Category。

Objective-C方法命名

1.方法应使用小写开头的驼峰法命名，每个参数都应该小写开头。

2.方法名应该尽可能读起来像一句话，参数名就如同方法名的补充说明(比如convertPoing:fromRect: 或者 replaceCharactersInRange:withString: )。

3.方法明中要避免单词缩写。

- (void)setBGImage:(UIImage *)img; //避免

- (void)setBackgroundImage:(UIImage *)image; //推荐

变量的命名

变量名应使用小写开头的驼峰法命名。

类成员变量名应该以一个下划线开始。

常量(预定义，枚举，局部常量等)使用小写k开头的驼峰法。例如：

localVariable; //局部变量

_instanceVariable; //成员变量