iOS 注释方法大全 代码块加快捷键注释

栏目: 编程工具 · IOS · 发布时间: 7年前

内容简介:iOS 注释方法大全 代码块加快捷键注释

注释规范

良好的编码规范是 程序员 必备的素质,编码中的代码注释尤为重要,健全的代码注释可以提高代码可读性和维护性,不仅为了标识此块代码的含义,很多时候包含了对业务逻辑的解释,项目中难免有逻辑复杂之处,不加注释的代码,数日后自己看都会觉得陌生,更不要说其他人看了,今天分享一下Objective-C开发中常用的代码注释方式以及应用场合。

注释形式

注释形式主要有:

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

1. 单行注释

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

iOS 注释方法大全 代码块加快捷键注释

2. 多行注释

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

iOS 注释方法大全 代码块加快捷键注释

3. 方法注释

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

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

iOS 注释方法大全 代码块加快捷键注释

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

iOS 注释方法大全 代码块加快捷键注释

4:方法集注释(配合代码块实现快速注释)

先介绍一下,何为方法集注释,通常没有添加方法集的类是这样的:

iOS 注释方法大全 代码块加快捷键注释

为了快速定位类中的某块代码,或某个方法,Xcode为我们提供了方法集的注释方式,可大大减少搜寻目标代码的时间,如图:

iOS 注释方法大全 代码块加快捷键注释

这样就能对类中的方法和模块一览无余,要查找或修改的时候可以迅速定位,节省时间,提高自我体验。

实现方法:

#pragma mark<#注释的内容#>

但是每次敲这些字符一定不是你想要的效果,在Xcode8之前可以使用 VVDocumenter增强版 (个人在原基础上修改添加方法集注释功能),由于Xcode8默认禁用使用插件,所以我们采用代码块+快捷键的方式来实现,效果也是酸爽:

iOS 注释方法大全 代码块加快捷键注释

上图中,就是我使用代码块+快捷键来实现的方法集注释,编写方便,快捷,具体实现步骤如下:

添加代码块并设置快捷键:

iOS 注释方法大全 代码块加快捷键注释

这样就大功告成,保存代码块,在代码中使用预设的快捷键,编译器会自动提示,回车,输入即可。

记得代码块预设的时候“注释内容外要用<#>” 。

iOS 注释方法大全 代码块加快捷键注释


以上就是本文的全部内容,希望本文的内容对大家的学习或者工作能带来一定的帮助,也希望大家多多支持 码农网

查看所有标签

猜你喜欢:

本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们

Java5.0Tiger程序高手秘笈

Java5.0Tiger程序高手秘笈

BrettMclaughlin / 东南大学出版社 / 2005-10 / 28.00元

代号为 “Tiger”的下一个 Java 版本,不只是个小改动版。在语言核心中有超过 100 项以上的变动,同时有大量的对 library 与 API 所做的加强,让开发者取得许多新的功能、工具与技术。但在如此多的变化下,应该从何处开始着手?也许可以从既长又无趣的语言规范说明书开始看起;或等待最少 500 页的概念与理论巨著出版;甚至还可以直接把玩新的 JDK 看看能够有什么发现;或者借由《Jav......一起来看看 《Java5.0Tiger程序高手秘笈》 这本书的介绍吧!

HTML 压缩/解压工具
HTML 压缩/解压工具

在线压缩/解压 HTML 代码

URL 编码/解码
URL 编码/解码

URL 编码/解码

RGB CMYK 转换工具
RGB CMYK 转换工具

RGB CMYK 互转工具