【iOS】Object-C注释
与其他语言一样,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
如果安装了 VVDocument ,当输入///的时候回自动生成多行注释,通常我们通过 /** 注释内容 */ 进行注释
@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、函数注释
函数注释也属于多行注释,通常我们使用 VVDocument 插件辅助
/**
* 获取状态描述
*
* @param state 状态值
*
* @return 返回状态描述
*/
- (NSString *)getState:(NSInteger)state
{
switch (state) {
case :
return @"待确认";
break;
case :
return @"确认";
break;
case :
return @"驳回";
break;
}
}
在实际开发中,我们应该多使用文档注释,使用文档注释可以获得xcode的智能提示,在用appledoc生成文档的时候也可以被识别
参考链接:http://www.cnblogs.com/zyl910/archive/2013/06/07/objcdoc.html
【iOS】Object-C注释的更多相关文章
- ios Object Encoding and Decoding with NSSecureCoding Protocol
Object Encoding and Decoding with NSSecureCoding Protocol February 27, 2014 MISC NSCoding is a fanta ...
- IOS Object和javaScript相互调用
在IOS开发中有时会用到Object和javaScript相互调用,详细过程例如以下: 1. Object中运行javascript代码,这个比較简单,苹果提供了非常好的方法 - (NSString ...
- iOS文档注释
Eclipse和IntelliJ IDEA系的IDE都有自动生成文档注释的功能,Xcode虽然安装了VVDocument,但是仍然感觉注释的功能不是很完善,于是今天整理了一下书写文档注释的一些用法. ...
- iOS端项目注释规范附统一代码块
代码的注释经常被人忽略,以至于在后期维护的时候较为困难.我们准备在XX项目开始之前制定一套规范的注释体系,致力于达到就算维护人员改变也能快速上手的效果. 1.属性注释 属性注释 使用 /** 注释*/ ...
- iOS:Tools:快速注释Doxygen
Xcode5有个新特性就是自己定义的函数也会被检测集成到代码提示里面,也就是在Quick Help有提示.如 /** * @brief 设置id * * @param id 要设置的id */ +(v ...
- 12_传智播客iOS视频教程_注释和函数的定义和调用
OC的注释和C语言的注释一模一样.它也分单行注释和多行注释. OC程序里面当然可以定义一个函数.并且定义的方式方法和调用的方式方法和我们C语言是一模一样的.OC有什么好学的?一样还学个什么呢? 重点是 ...
- iOS xcode 8 注释快捷键
单行注释:在方法的地方按 Command+/ 标注的功能,快捷键是Command + Option + / 需要在方法名的上面(空白)的地方按 Command + Option + / 才管 ...
- IOS,Object C学习过程中遇到的attributes
@property 定义一个属性 @synthesize 告诉编译器自动为属性自动生成 getter 和setter方法 在定义属性的时候会用到如下@attributes nonatomic,告诉编译 ...
- iOS 点击注释图标 弹出对应解释
需求:如题目 接上一篇的开发内容 效果图: 这种情况存在tableView 的一个cell中. 要点 1, 弹出的对应解释 要在可视区域,并且小尖角 要指着 图片 2, 文本不能过高 有极大高度 ...
随机推荐
- 面向对象架构模式之:领域模型(Domain Model)
一:面向对象设计中最简单的部分与最难的部分 如果说事务脚本是 面向过程 的,那么领域模型就是 面向对象 的.面向对象的一个很重要的点就是:“把事情交给最适合的类去做”,即:“你得在一个个领域类之间跳转 ...
- Lucene系列-分析器
分析器介绍 搜索的基础是对文本信息进行分析,Lucene的分析工具在org.apache.lucene.analysis包中.分析器负责对文本进行分词.语言处理得到词条,建索引和搜索的时候都需要用到分 ...
- 3.实现一个名为Person的类和它的子类Employee,Employee有两个子类Faculty 和Staff。
23.实现一个名为Person的类和它的子类Employee,Employee有两个子类Faculty 和Staff. 具体要求如下: (1)Person类中的属性有:姓名name(String类型) ...
- 控制台屏蔽某console的输出
有时候需要调试一个在线网站. 打开 chrome 控制台,其中有一些 console.log 不停的输出. 这样的话就影响了我们使用控制台调试页面. 那么怎样不让那一句(或多句)console.log ...
- 好友录v1.2.7_Build(7790)
<好友录>是使用.net Framework4.0+sqlite开发的,属于WingKu(谷毅科技)系列软件之一.它是一款外观时尚.美观,操作简单.易用,功能强大的个人通讯信息管理软件.它 ...
- gulp/grunt和browserify/webpack的区别
Gulp应该和Grunt比较,他们的区别我就不说了,说说用处吧.Gulp / Grunt 是一种工具,能够优化前端工作流程.比如自动刷新页面.combo.压缩css.js.编译less等等.简单来说, ...
- Python中的运算符
说完常用的数据类型,再来说下运算符.运算符用于将各种类型的数据进行运算,让静态的数据跑起来. 编程语言中的运算大致分为以下几个大类: 算术运算, 用于加减乘除等数学运算 赋值运算,用于接收运算符或方法 ...
- hibernate(四) 双向多对多映射关系
序言 莫名长了几颗痘,真TM疼,可能是现在运动太少了,天天对着电脑,决定了,今天下午花两小时去跑步了, 现在继上一章节的一对多的映射关系讲解后,今天来讲讲多对多的映射关系把,明白了一对多,多对多个人感 ...
- WPF中找不到Image或者Image不是Drawing系列
WPF中默认没有引用WinForm里面的一些东西,都是用它自带的那一套,但又不能完全脱离,所以有的时候比较蛋疼
- python第二天 - 异常处理
简单罗列一下知识点: 一.基本写法 try: html = _respose.read().decode('utf-8')except Exception as e: pass 捕获多个异常 ...