swift使用注释的几种方式 – Swift最新教程

上一章Swift教程请查看：Swift表达式，语句和代码块

在本文中，你将了解Swift注释，以及如何正确使用注释。

注释是程序源代码中程序员可读的解释或注释，当编译代码时，编译器会忽略它。

注释是为了让阅读代码的人更好地理解程序的意图和功能。在团队工作时，为其他团队成员注明代码的用途是很有帮助的，或者在单独工作时，它可以作为提醒来拥有代码。

Swift注释及其类型

在swift中有两种类型的注释：

1. 单行注释

在Swift中，任何以两个斜杠//开头的行都是单行注释，以两个斜杠//开头的所有内容都会被编译器忽略。

你可以在项目顶部找到一个简单的例子：

// 实现二项队列

它以两个斜线//开头，并对文件进行了有意义的解释。

示例1：单行注释

// 简单程序
// 在变量pi中存储3.14
let pi = 3.14159 
print(pi)

2. 多行注释

如果你的注释包含多行，你可以把它放在/*…*/里面。

多行注释以一个前斜杠和一个星号(/*)开始，以一个星号和一个前斜杠(*/)结束，在/*和*/之间的所有内容都会被swift编译器忽略。

/*这是一个多行注释。在你写完多行注释后，在后面加上*和/来结束它* /

示例2：多行注释

/* 硬编码的pi值可能不太准确。因此，你可以在构建的数据类型中计算更精确的值 */
let pi = Double.pi
print(pi)

代码注释要注意的地方

注释对于更好地理解编写代码的意图是有意义的，以下是你写注释时需要考虑的问题：

1、不要在多行中使用//将注释括起来，尽管它是有效的，编译器会忽略这些行，而是把它放在多行注释/*…*/中

例子：

// 这是注释。
// 必要时精确地使用它

上面写注释的方法是正确的，但不建议这样做，因为如果注释大于一行，就需要写多行注释。更好的写法是使用多行注释：

/* 这是注释。
必要时精确地使用它 */

2、单行注释可以在单独的行中编写，也可以与同一行中的代码一起编写。但是，建议在单独的行中使用注释。

例子：

let pi = 3.14159 // 在变量pi中存储3.14

这种写注释的方法是有效的，但是最好在单独的一行中写注释：

// 在变量pi中存储3.14
let pi = 3.14159 

3、即使你是团队中的一个开发人员，并且你是惟一编写代码的人，如果代码未被注释，那么你也很难理解它在程序中的用途。所以，准确地使用它，并提供一个有意义的描述。

4、让注释变得简单而有意义。

5、不要在代码上写不必要的注释。

6、在大多数情况下，使用注释来解释“为什么”而不是“如何”。