返回

想见你:细说interface的11条规范写法

IOS

interface的规范写法

  1. 使用@interface开始类声明。
  2. 类名应大写字母开头,并以分号结尾。
  3. 协议声明应使用@protocol关键字,并以分号结尾。
  4. 方法声明应使用@optional或@required关键字修饰,并以分号结尾。
  5. 属性声明应使用@property关键字,并以分号结尾。
  6. 常量声明应使用const关键字,并以分号结尾。
  7. 枚举声明应使用enum关键字,并以分号结尾。
  8. 结构体声明应使用struct关键字,并以分号结尾。
  9. 联合声明应使用union关键字,并以分号结尾。
  10. typedef声明应使用typedef关键字,并以分号结尾。
  11. 外部声明应使用extern关键字,并以分号结尾。

相关宏的介绍

说明
@implementation 开始类的实现
@end 结束类的声明或实现
@synthesize 自动生成属性的存取方法
@dynamic 声明属性是动态的
@class 声明一个类的引用
@protocol 开始协议的声明
@optional 声明协议中的方法是可选的
@required 声明协议中的方法是必需的

定义方法时有用的修饰符

修饰符 说明
+ 类方法
- 实例方法
@protected 受保护的方法
@private 私有方法
@public 公共方法

编写注释的规范

  1. 使用/***/注释多行内容。
  2. 使用//注释单行内容。
  3. 注释应清晰、简洁,并能准确地代码的功能。
  4. 注释应放在代码的适当位置,以便于阅读和理解。

举个例子

@interface Person : NSObject

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

- (void)sayHello;

@end

这是一个Person类的interface声明。该类有两个属性,分别是name和age,以及一个方法sayHello。name属性是字符串类型,age属性是整型。sayHello方法是一个实例方法,没有参数,也没有返回值。

结语

以上就是interface声明时需要注意的11条规范,以及相关宏、修饰符和注释规范。希望本文能帮助您编写合格的头文件。