Swift Kommentare

在本文中，您将了解Swift注释，为什么以及如何使用它们。

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

注释是为了让阅读代码的人更好地理解程序的意图和功能。在团队中工作时，为其他团队成员澄清代码的目的可能会很有帮助，或者在单独工作时，它可以起到提醒自己的作用。

Swift 注释及其类型

Swift有两种类型的注释：

1.单行注释

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

您可以在 playground 的顶部找到一个简单的示例：

//: Playground　-　noun: a place where people can play

它以两个斜杠 // 开头，并对文件提供了有意义的解释，例如：“Playground - noun: a place where people can play。

示例1：单行注释

//Sample program
//speichert　3.14　in　variable　pi
let　pi　=　3.14159　
print(pi)

上面的示例包含两个单行注释：

//　Sample program
//　speichert　3.14　in　variable　pi

2.多行注释

如果您的注释包含多行，则可以将其括在中/*...*/。

多行注释以正斜杠开头，后跟星号(/*) ，以星号结尾，后跟正斜杠(*/)。Swift 编译器会忽略/* 和 */之间的所有内容。

/*　这是一个多行注释。
在您编写多行注释后，添加*，后跟/以结束它
*/

示例2：多行注释

/*　硬编码的 pi 值可能不那么精确。
因此，您可以使用内置数据类型计算更准确的值
*/
let pi = Double.pi
print(pi)

上面的示例包含多行注释。

/*　硬编码的 pi 值可能不那么精确。
因此，您可以使用内置数据类型计算更准确的值
*/

要记住的事情

尽管注释对于更好地理解所编写代码的意图很有意义。但是需要注意的是：

1. 不要在多行中将注释包含在。//尽管它是有效的，并且编译器忽略这些行。相反，应该把它放在多行注释中。/* ... */中
   Beispiel:

   //Dies ist ein Kommentar.
   //Verwenden Sie es, wenn notwendig und genau

   Die obige Methode zum Schreiben von Anmerkungen ist korrekt, aber nicht empfohlen, weil wenn Anmerkungen mehr als eine Zeile sind, müssen sie als mehrzeilige Anmerkungen geschrieben werden. Eine bessere Schreibweise ist, mehrzeilige Anmerkungen als zu verwenden:

   /*　Dies ist ein Kommentar.
   Verwenden Sie es, wenn notwendig und genau
   */

2. Einzeilige Anmerkungen können in einer单独en Zeile stehen oder mit dem Code auf der gleichen Zeile stehen. Aber es wird empfohlen, Anmerkungen in einer单独en Zeile zu verwenden.
   Beispiel:

   let　pi　=　3.14159　//speichert　3.14　in　variable　pi

   Diese Methode zum Schreiben von Anmerkungen ist wirksam. Aber es ist besser, Anmerkungen auf einer separaten Zeile zu schreiben:
   

   //speichert　3.14　in　variable　pi
   let　pi　=　3.14159

3. Selbst wenn Sie ein einziger Entwickler in einem Team sind und der einzige sind, der Code schreibt, ist es schwer, den Zweck des Codes zu finden, wenn er keine Anmerkungen hat. Also verwenden Sie es genau und geben Sie eine bedeutungsvolle Beschreibung.

4. Machen Sie die Anmerkungen sehr einfach und bedeutungsvoll.

5. Schreiben Sie keine unnötigen Anmerkungen auf den Code.

6. In den meisten Fällen sollten Sie Anmerkungen verwenden, um zu erklären 'warum' anstatt 'wie'.