每一个文件都必须写文件注释，文件注释通常包含

• 文件所在模块
• 历史版本信息
• 文件包含的内容，作用

一段良好文件注释的栗子：

文件注释的格式通常不作要求，能清晰易读就可以了，但在整个工程中风格要统一。

代码注释

方法、函数、类、协议、类别的定义都需要注释，推荐采用Apple的标准注释风格，好处是可以在引用的地方自动弹出注释，非常方便。

有很多可以自动生成注释格式的插件，推荐使用：

协议、委托的注释要明确说明其被触发的条件：

如果在注释中要引用参数名或者方法函数名，使用||将参数或者方法括起来以避免歧义：

定义在头文件里的接口方法、属性必须要有注释！