MK
摩柯社区 - 一个极简的技术知识社区
AI 面试

Objective-C代码规范：命名约定与语法风格指南

2021-06-231.4k 阅读

命名约定

1. 类名

在Objective - C中，类名的命名应该采用驼峰命名法（Camel Case），并且首字母大写。这种命名方式能够清晰地将类与其他类型（如变量、函数等）区分开来。同时，类名应该尽可能描述该类的功能或所代表的事物。

例如，创建一个表示用户信息的类，我们可以命名为UserInfo。代码示例如下：

#import <Foundation/Foundation.h>

@interface UserInfo : NSObject

@property (nonatomic, strong) NSString *name;
@property (nonatomic, assign) NSInteger age;

@end

@implementation UserInfo

@end

使用驼峰命名法使得类名易于阅读和理解，从UserInfo这个名字就能直观地知道这个类是用于处理用户信息相关的操作。

2. 协议名

协议名同样采用驼峰命名法且首字母大写，通常以Delegate或者DataSource结尾，用于表明其用途。例如，当我们创建一个用于处理视图数据加载的协议，可以命名为DataLoadingDelegate。

#import <Foundation/Foundation.h>

@protocol DataLoadingDelegate <NSObject>

- (void)dataDidLoadSuccessfully;
- (void)dataLoadFailedWithError:(NSError *)error;

@end

这种命名方式使得开发者能够快速识别出该协议是与数据加载的代理操作相关。

3. 方法名

方法名遵循驼峰命名法，首字母小写。方法名应该清晰地描述该方法的功能，并且要尽可能包含足够的信息，使得调用者在不查看方法实现的情况下，就能明白该方法的作用。

例如，一个用于计算两个整数之和的方法，可以命名为addNumber1:withNumber2:。代码如下：

#import <Foundation/Foundation.h>

@interface MathCalculator : NSObject

- (NSInteger)addNumber1:(NSInteger)number1 withNumber2:(NSInteger)number2;

@end

@implementation MathCalculator

- (NSInteger)addNumber1:(NSInteger)number1 withNumber2:(NSInteger)number2 {
    return number1 + number2;
}

@end

方法名中的参数部分也应该是描述性的，addNumber1:withNumber2:中的number1和number2明确指出了参数的含义，让调用者清楚知道需要传入什么参数。

对于类方法，命名规则与实例方法相同，但通常会在方法名中体现出类相关的信息。比如，一个用于创建UserInfo类实例的类方法，可以命名为userInfoWithName:andAge:。

#import <Foundation/Foundation.h>

@interface UserInfo : NSObject

@property (nonatomic, strong) NSString *name;
@property (nonatomic, assign) NSInteger age;

+ (instancetype)userInfoWithName:(NSString *)name andAge:(NSInteger)age;

@end

@implementation UserInfo

+ (instancetype)userInfoWithName:(NSString *)name andAge:(NSInteger)age {
    UserInfo *user = [[self alloc] init];
    user.name = name;
    user.age = age;
    return user;
}

@end

4. 变量名

变量名采用驼峰命名法，首字母小写。局部变量的命名应该能够清晰地表达其用途，例如，在一个循环中用于计数的变量可以命名为count。

for (NSInteger count = 0; count < 10; count++) {
    NSLog(@"The count is %ld", (long)count);
}

成员变量（实例变量）在命名时，通常会在变量名前加上下划线_。这样可以将成员变量与局部变量以及属性区分开来。例如，在UserInfo类中，我们可以定义如下成员变量：

#import <Foundation/Foundation.h>

@interface UserInfo : NSObject {
    NSString *_name;
    NSInteger _age;
}

@end

@implementation UserInfo

@end

属性变量命名遵循与变量相同的驼峰命名法规则，例如：

#import <Foundation/Foundation.h>

@interface UserInfo : NSObject

@property (nonatomic, strong) NSString *name;
@property (nonatomic, assign) NSInteger age;

@end

@implementation UserInfo

@end

5. 常量名

常量名一般采用全大写字母，单词之间用下划线分隔。这样可以明显地将常量与其他变量区分开来。例如，定义一个表示圆周率的常量：

const CGFloat kPi = 3.1415926;

在Objective - C中，还常用k作为前缀来表示常量，如上面的kPi。这种命名方式使得常量在代码中非常醒目，易于识别和维护。

语法风格

1. 代码缩进

在Objective - C中，通常使用4个空格进行代码缩进。缩进能够清晰地表示代码块的层次结构，提高代码的可读性。例如，在一个方法的实现中：

- (void)printUserInfo {
    NSLog(@"Name: %@", self.name);
    if (self.age > 0) {
        NSLog(@"Age: %ld", (long)self.age);
    } else {
        NSLog(@"Age information is not available.");
    }
}

可以看到，方法体内部的代码使用4个空格进行缩进，if - else代码块也同样缩进，使得代码结构一目了然。

2. 花括号的使用

花括号的位置在Objective - C中有一定的规范。对于if、else、for、while等语句块，左花括号{通常与语句在同一行，右花括号}单独占一行。例如：

if (self.age > 18) {
    NSLog(@"The user is an adult.");
} else {
    NSLog(@"The user is a minor.");
}

对于类和方法的定义，左花括号{同样与类或方法声明在同一行，右花括号}单独占一行，并且在类的右花括号后需要加上分号。例如：

@interface UserInfo : NSObject {
    NSString *_name;
    NSInteger _age;
}

- (void)printUserInfo;

@end

@implementation UserInfo

- (void)printUserInfo {
    NSLog(@"Name: %@", self.name);
    NSLog(@"Age: %ld", (long)self.age);
}

@end

这样的花括号使用方式是Objective - C社区中广泛接受的风格，有助于保持代码的一致性和可读性。

3. 语句分行

每个语句应该单独占一行，这样可以使代码更易于阅读和调试。例如：

NSInteger number1 = 10;
NSInteger number2 = 20;
NSInteger sum = number1 + number2;
NSLog(@"The sum is %ld", (long)sum);

避免将多个语句写在同一行，如NSInteger number1 = 10; NSInteger number2 = 20; NSInteger sum = number1 + number2;，这种写法会降低代码的可读性。

4. 注释规范

注释在Objective - C代码中非常重要，它能够帮助其他开发者（包括自己在未来回顾代码时）理解代码的功能和意图。

单行注释使用//，通常用于对某一行代码进行简短的解释。例如：

// 计算两个数的和
NSInteger sum = number1 + number2;

多行注释使用/* */，用于对一段代码块进行详细的说明。例如：

/*
这段代码用于根据用户的年龄判断其是否成年
如果年龄大于18岁，输出用户是成年人
否则，输出用户是未成年人
*/
if (self.age > 18) {
    NSLog(@"The user is an adult.");
} else {
    NSLog(@"The user is a minor.");
}

此外，在类和方法的定义前，也应该使用注释来描述其功能、参数和返回值等信息。例如：

/**
 * 创建一个UserInfo类的实例
 *
 * @param name 用户的名字
 * @param age 用户的年龄
 * @return 返回一个UserInfo类的实例
 */
+ (instancetype)userInfoWithName:(NSString *)name andAge:(NSInteger)age {
    UserInfo *user = [[self alloc] init];
    user.name = name;
    user.age = age;
    return user;
}

这种注释方式有助于其他开发者快速了解类和方法的使用方法，提高代码的可维护性和可扩展性。

5. 点语法的使用

在Objective - C中，点语法主要用于访问属性。点语法使得代码更加简洁和易读。例如，访问UserInfo类中的name属性：

UserInfo *user = [[UserInfo alloc] init];
user.name = @"John";
NSString *name = user.name;

这里user.name就是使用点语法来设置和获取name属性的值。需要注意的是，点语法本质上是对setter和getter方法的一种简化写法。例如，user.name = @"John";实际上是调用了[user setName:@"John"];，而NSString *name = user.name;实际上是调用了NSString *name = [user name];。

6. 内存管理相关语法

在ARC（自动引用计数）环境下，开发者无需手动管理对象的内存释放，ARC会自动处理对象的生命周期。然而，在MRC（手动引用计数）环境下，需要遵循一定的内存管理语法。

当使用alloc、new、copy等方法创建对象时，需要调用release或autorelease来释放对象的所有权。例如：

// MRC环境下
NSString *string = [[NSString alloc] initWithString:@"Hello"];
[string release];

或者使用autorelease：

// MRC环境下
NSString *string = [[[NSString alloc] initWithString:@"Hello"] autorelease];

在ARC环境下，上述代码可以简化为：

// ARC环境下
NSString *string = [[NSString alloc] initWithString:@"Hello"];
// 无需手动调用release或autorelease

了解内存管理相关语法对于编写高效、稳定的Objective - C代码至关重要，特别是在处理复杂的对象关系和资源管理时。

7. 条件语句和循环语句的空格使用

在条件语句（如if、switch）和循环语句（如for、while）中，条件表达式的括号前后应该有空格，以提高代码的可读性。例如：

if ( self.age > 18 ) {
    NSLog(@"The user is an adult.");
}

for ( NSInteger i = 0; i < 10; i++ ) {
    NSLog(@"The value of i is %ld", (long)i);
}

这样的空格使用方式能够使条件表达式更加清晰，易于阅读和理解。

8. 操作符的空格使用

在Objective - C中，操作符（如+、-、*、/等）前后应该有空格，这样可以使表达式更加清晰。例如：

NSInteger result = number1 + number2;
NSInteger difference = number1 - number2;

对于赋值操作符=，同样应该在前后加上空格，如NSInteger number = 10;。这样的空格规范有助于提高代码的可读性，避免因表达式过于紧凑而产生的阅读困难。

9. 代码块之间的空行

在不同的代码块（如不同的方法实现之间、不同的if - else块之间等）之间，应该使用一个空行进行分隔。这样可以使代码结构更加清晰，便于阅读和维护。例如：

- (void)method1 {
    // method1的实现代码
    NSLog(@"This is method1.");
}

- (void)method2 {
    // method2的实现代码
    NSLog(@"This is method2.");
}

通过空行分隔不同的代码块，能够让开发者快速定位和区分不同功能的代码部分，提高代码的可维护性。

10. 头文件引用规范

在Objective - C中，头文件引用分为系统头文件和自定义头文件。引用系统头文件时，使用尖括号<>，例如：

#import <Foundation/Foundation.h>

引用自定义头文件时，使用双引号""，例如：

#import "UserInfo.h"

这样的规范有助于编译器准确地找到对应的头文件，同时也能清晰地区分系统头文件和自定义头文件，便于代码的管理和维护。

在编写Objective - C代码时，严格遵循上述命名约定和语法风格指南，能够使代码更加规范、易读、可维护，有助于团队协作开发和项目的长期发展。无论是新手开发者还是经验丰富的工程师，都应该始终坚持良好的代码规范，以提高代码质量和开发效率。同时，随着项目的不断演进和团队的壮大，代码规范的重要性会愈发凸显，它能够保证代码的一致性，降低沟通成本，使整个项目的开发过程更加顺畅。