博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
【iOS】Object-C注释
阅读量:6573 次
发布时间:2019-06-24

本文共 1537 字,大约阅读时间需要 5 分钟。

与其他语言一样,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生成文档的时候也可以被识别

参考链接:

转载地址:http://rzljo.baihongyu.com/

你可能感兴趣的文章
K:栈和队列的比较
查看>>
PHP中获取当前页面的完整URL
查看>>
【模板】左偏树(可并堆)
查看>>
Django框架之路由层、视图层
查看>>
深入分析escape()、encodeURI()、encodeURIComponent()的区别及示例
查看>>
正则查找文章内容关键字
查看>>
JS绘制拓扑图示例 (JTopo)
查看>>
世界最大电子展明年将移植到深圳
查看>>
iOS图片浏览器 - XLPhotoBrowser(类似微信多图片浏览效果)
查看>>
pymysql 单独获取表的栏位名称
查看>>
安卓srcCompat弄死我了
查看>>
实验四 递归下降语法分析程序设计
查看>>
虚幻4Matinee功能 基本概念及简单演示样例(Sequence编辑器)
查看>>
随机函数及随机公式推理过程
查看>>
Cookie的使用
查看>>
SQL的操作方法
查看>>
jsp简易登录和注册及JDBC连接Oracle
查看>>
新的三种EBS类型解析
查看>>
系统架构
查看>>
JVM内存结构、垃圾回收那点事(转)
查看>>