3.3　注释

Swift程序有两类注释：单行注释（//）和多行注释（/*…*/）。注释方法与C、C++和Objective-C语言都是类似的，下面详细介绍一下。

  1. 单行注释

单行注释可以注释整行或者一行中的一部分，一般不用于连续多行的注释文本。当然，它也可以用来注释连续多行的代码段。以下是两种注释风格的例子：

  1. if x > 1 {
  2.     //注释1
  3. } else {
  4.     return false //注释2
  5. }
  7. //if x > 1 {
  8. //    //注释1
  9. //} else {
  10. //    return false //注释2
  11. //}

提示　在Xcode中对连续多行的注释文本可以使用快捷键：选择多行然后按住“command+/”键进行注释。去掉注释也是按住“command+/”键。

  1. 块注释

一般用于连续多行的注释文本，但也可以对单行进行注释。以下是几种注释风格的例子：

  1. if x > 1 {
  2.     /* 注释1 */
  3. } else {
  4.     return false /* 注释2 */
  5. }
  7. /*
  8. if x > 1 {
  9.     //注释1
  10. } else {
  11.     return false //注释2
  12. }
  13. */
  15. /*
  16. if x > 1 {
  17.     /* 注释1 */
  18. } else {
  19.     return false /* 注释2 */
  20. }
  21. */

提示　Swift多行注释有一个其他语言没有的优点，就是可以嵌套，上述示例的最后一种情况便实现了多行注释嵌套。

在程序代码中，对容易引起误解的代码进行注释是必要的，但应避免对已清晰表达信息的代码进行注释。需要注意的是，频繁的注释有时反映了代码的低质量。当你觉得被迫要加注释的时候，不妨考虑一下重写代码使其更清晰。