iOS 注释规范

iOS注释规范&&提高注释效率

iOS注释主要分为以下几种：属性注释、方法集注释、方法注释、普通注释（单行注释）。

1.属性注释

该类注释主要用于属性，变量名的注释。提高效率方法见下面代码块的使用。

2.方法集注释

方法集注释就是对多个方法进行统一注释，统一解释几个方法大体类型，特别对一些代码比较长的代码文件，在点击代码编写界面上方的代码路径后段查看代码里面所有的方法时候，可以有效的看出哪些方法进行的什么操作，从而可以快速定位方法。

方法集注释如下所示

方法集注释效率的提高见下面代码块的使用。

3.方法注释

方法注释推荐采用VVDocument插件进行注释，最新的xcode-8里面的系统文件里就有该插件的文件，足以可见这款插件是相当不错的。

---

VVDocument Github地址

方法注释主要对单个方法进行注释，使用VVDocument插件注释方法很简单，连续点击三次”///”就会出现注释。并且它会自动识别方法名中的变量，然后打印出来。注释最上面是对方法功能的介绍，变量名的文字是对变量名的解释。

4.普通注释

所谓普通注释就是代码片段里有一句需要解释下，和绝大多数语言一样。双斜杠进行注释。或者采用统一样式

5.代码块在注释中的使用

Xcode自带的代码块是一个非常好用的工具，可以快速的通过快捷键打出你想要的代码，代码块主要如图下所示。加入代码块的方法请百度，这里不介绍了。

下面介绍下我写的几个注释的代码块,其中title是定义的代码块名称，shortcut是快捷键。在代码中打出快捷键就回弹出相应的代码块供你选择，极大的提高代码编写效率。

1)方法集注释

2)属性注释

3)普通注释