如何在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

解釋

函式的目的和結構已在函式定義之前進行了描述。

使用註釋的好處

• 使程式碼更容易理解 − 註釋使程式碼更容易理解，方便日後參考。這對其他開發者也很有幫助。

• 用於除錯 − 在除錯時，註釋對於識別不完整或有錯誤的程式碼非常有用。如果您的程式碼不完整，或者您有一個需要稍後處理的問題，可以編寫單行註釋。

結論

我們應該始終使用註釋來解釋我們為什麼這樣做，而不是我們如何這樣做。不應透過註釋來解釋編寫不良的程式碼。

註釋可以告訴您一段程式碼為什麼有效。請記住，您首先編寫程式碼是為了讓其他程式設計師使用，因此瞭解編寫高質量註釋的原則對專案質量大有裨益。