在计算机编程中,注释是我们用来使代码更易于理解的提示。
注释会被编译器完全忽略。它们是为其他程序员准备的。
在 Swift 中有两种添加注释的方法
//
- 单行注释/*...*/
- 多行注释
单行注释
在 Swift 中,任何以 //
开头的行都是单行注释。例如:
// create a variable
var name = "Cartman"
// print the value
print(name)
在这里,我们创建了两个单行注释
// 创建一个变量
// 打印值
我们也可以将单行注释与代码一起使用。
var name = "swift" // name is a string
多行注释
在 Swift 中,/*
和 */
之间的任何文本都是多行注释。例如:
/* create a variable
to store salary of employees
*/
var salary = 10000
print(salary)
在上面的例子中,我们使用 /*...*/
来编写跨越多行的注释。
Swift 注释的用途
1. 使代码更易于理解如果我们在代码中编写注释,方便日后参考。
此外,其他开发人员也能更容易地理解代码。
2. 使用注释进行调试如果在运行程序时遇到错误,我们可以注释掉导致错误的行而不是删除它。例如:
print("Swift")
// print("Error Line )
print("UIKit")
这里,print("Error Line)
导致了错误,所以我们将其更改为注释。现在,程序运行正常。
这就是注释如何成为有价值的调试工具。
注意: 始终使用注释来解释我们为什么这样做,而不是我们是如何做到的。注释不应替代解释写得不好的代码的方式。