代码注释

注释形式
单行注释,多行注释,方法注释,方法集注释(配合代码块实现快速注释)

1. 单行注释

  • 使用 // 注释单行代码,最常见的使用场景是在方法内注释某个属性或某块区域的含义。

2. 多行注释

  • 使用 /** 文本 **/ 的注释格式(快捷键cmd+option+/)可以对属性和类以及方法进行注释,与//不同的是,该注释方式可以写多行,一般使用在类的头文件,多行介绍当前类的含义。
属性注释.png

3. 方法注释

  • 与方法2相同,使用 /** 文本 **/ 的注释格式(快捷键cmd+option+/)可以对方法进行注释,快捷键会根据方法参数自动生成需要填写的注释内容,并且在其他地方使用该方法时,Xcode会智能提示出之前写的注释内容,如下图:

在方法上方使用快捷键 cmd+option+/:


方法注释.png

使用该方法时显示注释内容:

调用方法显示注释.png

4:方法集注释 【方便快速查找】

#pragma mark --- 测试Action

  • 为了快速定位类中的某块代码,或某个方法,Xcode为我们提供了方法集的注释方式,可大大减少搜寻目标代码的时间,如图:
快速查找.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

友情链接更多精彩内容