如何在Swift中编写多行注释？

---

在本文中，我们将讨论Swift的注释，以及如何在Swift中正确使用它们。

编写代码时，请始终记住一点，即：

代码必须尽可能易于人们阅读和理解。

与Swift语言类似，注释对于使您的代码更容易被您和其他开发者理解非常有用。代码中的所有注释都被Swift编译器完全忽略。

Swift中有两种类型的注释：

• 单行注释

• 多行注释

单行注释

语法

Swift允许我们使用单行注释进行简短的解释。

// Write your message here...

示例

我们在编写单行注释时使用了两个正斜杠 (//)。

// this function is created to print full name
func printFullName(firstName: String, lastName: String) {
   // print full name here
   print("\(firstName) \(lastName)")
}
// calling the function with first and last name
printFullName(firstName: "Rose", lastName: "Bush")

输出

Rose Bush

解释

通过阅读上面示例中的第一行（单行注释），可以很容易地理解此函数的目的。此函数用于显示全名。

多行注释

语法

多行注释以正斜杠后跟星号 (/*) 开头，以星号后跟正斜杠 (*/) 结尾。

/*
You can write a description on multiple lines here.
*/

示例

/* 和 */ 之间的文本是多行注释。

/*
Use this function to print the full name.
 
Parameters:
firstName: A string value that accepts the first name
lastName: A string value that accepts the last name
*/
func printFullName(firstName: String, lastName: String) {
    
   // print full name here
   print("\(firstName) \(lastName)")
}
// calling the function with first and last name
printFullName(firstName: "Rose", lastName: "Bush")

输出

Rose Bush

解释

函数的目的和结构已在函数定义之前进行了描述。

使用注释的好处

• 使代码更容易理解 − 注释使代码更容易理解，方便日后参考。这对其他开发者也很有帮助。

• 用于调试 − 在调试时，注释对于识别不完整或有错误的代码非常有用。如果您的代码不完整，或者您有一个需要稍后处理的问题，可以编写单行注释。

结论

我们应该始终使用注释来解释我们为什么这样做，而不是我们如何这样做。不应通过注释来解释编写不良的代码。

注释可以告诉您一段代码为什么有效。请记住，您首先编写代码是为了让其他程序员使用，因此了解编写高质量注释的原则对项目质量大有裨益。