# Swift 注釋 > 原文： [https://www.programiz.com/swift-programming/comments](https://www.programiz.com/swift-programming/comments) #### 在本文中，您將了解 Swift 注釋，為什么以及如何使用它們。 注釋是程序源代碼中程序員可讀的解釋或注釋。 編譯代碼時，[編譯器](https://en.wikipedia.org/wiki/Compiler "Compiler")將忽略它。 注釋旨在供閱讀代碼的人員使用，以更好地理解程序的意圖和功能。 在團隊中為其他團隊成員闡明代碼的目的時，或者在單獨工作時，它可能會提示自己擁有該代碼。 * * * ## 注釋及其類型 快速有兩種類型的注釋： ### 1.單行注釋 在 Swift 中，任何以兩個斜杠`//`開頭的行都是單行注釋。以兩個斜杠`//`開頭的所有內容都將被編譯器忽略。 您可以在游樂場的頂部找到一個簡單的示例： ```swift //: Playground - noun: a place where people can play ``` 它以兩個斜杠`//`開頭，并以`: Playground - noun: a place where people can play`（游樂場 - 名詞：人們可以玩耍的地方）的形式對文件進行了有意義的說明。 #### 示例 1：單行注釋 ```swift //Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi) ``` 上面的示例包含兩個單行注釋： ```swift // Sample program // stores 3.14 in variable pi ``` * * * ### 2.多行注釋 如果您的注釋包含多行，則可以將其括在`/*...*/`中。 多行注釋以正斜杠后跟一個星號（`/*`）開頭，以一個星號后跟一個正斜杠（`*/`）結尾。 快速編譯器將忽略`/*`和`*/`之間的所有內容。 ```swift /* This is a multiline comment. After you write multiline comment add * following by / to end it */ ``` #### 示例 2：多行注釋 ```swift /* Hardcoded pi value may be less accurate. So you can calculate using in built data types for more accurate value */ let pi = Double.pi print(pi) ``` 上面的示例包含多行注釋。 ```swift /* Hardcoded pi value may be less accurate. So you can calculate using in built data types for more accurate value */ ``` * * * ## 要記住的事情 盡管注釋對于更好地理解所編寫代碼的意圖很有意義。 這是您在編寫時需要考慮的事項： 1. 盡管注釋有效并且編譯器將忽略這些行，但不要在多行上用//括起注釋。 而是將其括在多行注釋中`/*...*/` **示例**： ```swift //This is a comment. //Use it when necessary and precisely ``` 上面的寫注釋方法是正確的，但不建議這樣做，因為如果注釋大于一行，更好的書寫方式是使用多行注釋，如下： ```swift /* This is a comment. Use it when necessary and precisely */ ``` 2. 單行注釋可以寫在單獨的行中，也可以與代碼一起寫在同一行中。 但是，建議在單獨的行中使用注釋。 **示例**： ```swift let pi = 3.14159 //stores 3.14 in variable pi ``` 這種寫注釋的方法有效。 但是最好在單獨的行中寫注釋為： ```swift //stores 3.14 in variable pi let pi = 3.14159 ``` 3. 即使您是團隊中的單個開發人員，并且您是唯一編寫該代碼的人，但是如果沒有注釋，您將很難在程序中確定其目的。 因此，請精確使用它并提供有意義的描述。 4. 使注釋非常簡單和有意義。 5. 不要在代碼上寫不必要的注釋。 6. 在大多數情況下，請使用注釋來解釋“為什么”而不是“怎么做”。