良好的编码规范是程序员必备的素质，编码中的代码注释尤为重要，健全的代码注释可以提高代码可读性和维护性，不仅为了标识此块代码的含义，很多时候包含了对业务逻辑的解释，项目中难免有逻辑复杂之处，不加注释的代码，数日后自己看都会觉得陌生，更不要说其他人看了，今天分享一下Objective-C开发中常用的代码注释方式以及应用场合。
OC
注释形式
注释形式主要有：
单行注释，多行注释，方法注释，方法集注释（配合代码块实现快速注释）
- 单行注释
使用 // 注释单行代码，最常见的使用场景是在方法内注释某个属性或某块区域的含义，如下图：
image
- 多行注释
使用 /** 文本 **/ 的注释格式（快捷键cmd+alt+/）可以对属性和类以及方法进行注释，与//不同的是，该注释方式可以写多行，一般使用在类的头文件，多行介绍当前类的含义，如下图：
image
- 方法注释
与方法2相同，使用 /** 文本 **/ 的注释格式（快捷键cmd+alt+/）可以对方法进行注释，快捷键会根据方法参数自动生成需要填写的注释内容，并且在其他地方使用该方法时，Xcode会智能提示出之前写的注释内容，如下图：
在方法上方使用快捷键 cmd+alt+/：
image
使用该方法时显示注释内容：
image
4：方法集注释（配合代码块实现快速注释）
为了快速定位类中的某块代码，或某个方法，Xcode为我们提供了方法集的注释方式，可大大减少搜寻目标代码的时间，如图：
image
这样就能对类中的方法和模块一览无余，要查找或修改的时候可以迅速定位，节省时间，提高自我体验。
实现方法：
( #pragma mark <#注释的内容#> )
但是每次敲这些字符一定不是你想要的效果，在Xcode8之前可以使用VVDocumenter增强版（个人在原基础上修改添加方法集注释功能），由于Xcode8默认禁用使用插件，所以我们采用代码块+快捷键的方式来实现，效果也是酸爽：
image
Swift
Xcode 常用代码标记 MARK、TODO、FIXME
MARK 标记
1）MARK 又叫做代码标注，我们可以使用它来添加一些说明文字。同时可以选择其上方是否需要显示分割线。
// MARK: 业务处理相关方法（上方不带分割线）
// MARK: - 数据请求相关方法（上方会带个分割线）
TODO 标记
（1）当我们写代码时，如果有一些功能需要以后添加或者补全，那么就可以使用 TODO 关键字来标记提醒。
// TODO: 需要记录操作日志
FIXME 标记
（1）通常我们在 bug 的位置使用 FIXME 做标记，提醒我们稍后需要进行修改。
// FIXME: 参数不正确时会导致崩溃
网友评论