与其他语言一样,Object-C的注释也分为两种,一种是普通注释,一种是文档注释,普通注释通常给阅读代码的人看,而文档注释可以被appledoc识别,在使用的时候xcode能给出智能提示
简单注释
1、单行注释单行注释不能被文档识别,通常用于函数内部
//学生信息
2、多行注释(这个也可以被识别)
/* * 多行注释内容 */
文档注释(appledoc可识别成文档)
1、单行注释
@interface Student : NSObject///名字@property (nonatomic, copy) NSString *name;///年龄@property (nonatomic, assign) NSInteger age;///校园卡Id@property (nonatomic, copy) NSString *schoolId;///年纪@property (nonatomic, copy) NSString *grade;@end
如果安装了 ,当输入///的时候回自动生成多行注释,通常我们通过 /** 注释内容 */ 进行注释
@interface Student : NSObject/** 名字 */@property (nonatomic, copy) NSString *name;/** 年龄 */@property (nonatomic, assign) NSInteger age;/** 校园卡Id */@property (nonatomic, copy) NSString *schoolId;/** 年纪 */@property (nonatomic, copy) NSString *grade;@end
2、多行注释
/** 简要描述. * * 详细描述或其他. */
3、行尾注释
如上面的单行注释,当属性多了之后看起来会比较混乱,我们也可以用下面的行尾注释,也可以被xcode识别
@interface Student : NSObject@property (nonatomic, copy) NSString *name; /**< 名字 */@property (nonatomic, assign) NSInteger age; /**< 年龄 */@property (nonatomic, copy) NSString *schoolId; /**< 校园卡Id */@property (nonatomic, copy) NSString *grade; /**< 年纪 */@end
4、函数注释
函数注释也属于多行注释,通常我们使用 插件辅助
/** * 获取状态描述 * * @param state 状态值 * * @return 返回状态描述 */- (NSString *)getState:(NSInteger)state{ switch (state) { case 1: return @"待确认"; break; case 2: return @"确认"; break; case 3: return @"驳回"; break; }}
在实际开发中,我们应该多使用文档注释,使用文档注释可以获得xcode的智能提示,在用appledoc生成文档的时候也可以被识别
参考链接: