iOS 添加注释

注释的意义

• 在我们日常开发过程中会写很多的代码，代码是自己写的当然自己在段时间内是知道这些代码是干什么用的。不过相信很多人在过很长一段时间会想不起来自己曾经写的代码的作用，为了避免这种情况所有语言都可以添加注释。就是对部分代码进行一个剪短的说明，这样的话能使自己或别人更好的知道这段代码的意思，就算是过了较长的时间回过头来看的时候也马上就能明白。一般添加注释就是用两斜杠 // 或 /***/，前者为单行注释，后者是多行注释，请大家知晓。

object-c 添加注释方式

• 大家习惯使用的注释方式应该是两斜杠//，其实你不妨试试三个斜杠///。
  给大家看一下///相应的属性和方法的效果：

/// 顶部视图
@property (strong, nonatomic) UIView *topView;

/// 测试app
- (void)testApp;

• 属性效果如下：

  
  三个斜杠属性的效果图片

• 方法效果如下：

  
  三个斜杠方法的效果图片

这样就很好的告知自己或其它对友这个属性或方法有什么作用了。
如果大家是看别人的代码的时候可以将光标放到方法或属性名的任意位置按键盘上的esc键就能显示对应的注释信息。

显示注释图片

多加一个斜杠就有怎么多的用途，希望您能get到。
不过大家发现添加注释它多占用了一行的空间，这样就会使我们的代码行数上会变多，所以我教大家另一种加注释的方式。

• 另一种加注释的方式
  请使用 //!<
  相应的代码：

@property (strong, nonatomic) UIView *topView;  //!< 顶部视图

- (void)testApp;    //!< 测试app

这样就可以在一行写完属性和相应的注释了，希望大家在以后的开发当中使用这种方式。