In diesem Artikel erfahren Sie mehr über Swift-Kommentare, warum und wie Sie sie verwenden.
Ein Kommentar ist eine vom Programmierer lesbare Erklärung oder Anmerkung im Quellcode eines Programms. Sie wird vom Compiler beim Kompilieren des Codes ignoriert.
Kommentare sind für Personen gedacht, die den Code lesen, um die Absicht und Funktionalität des Programms besser zu verstehen. Es kann hilfreich sein, während Sie in einem Team arbeiten, um den Zweck des Codes für andere Teammitglieder zu klären, oder wenn Sie nur arbeiten, kann dies als Erinnerung an den eigenen dienen.
Schneller Kommentar und seine Typen
In Kürze gibt es zwei Arten von Kommentaren:
1. Einzeiliger Kommentar
In Swift ist jede Zeile, die mit zwei Schrägstrichen beginnt, //ein einzeiliger Kommentar. Alles, was mit zwei Schrägstrichen beginnt, //wird vom Compiler ignoriert.
Oben auf dem Spielplatz finden Sie ein einfaches Beispiel:
//: Spielplatz - Substantiv: Ein Ort, an dem Menschen spielen können
Es beginnt mit zwei Schrägstrichen //und bietet eine aussagekräftige Erklärung der Datei als ": Spielplatz - Substantiv: ein Ort, an dem Menschen spielen können".
Beispiel 1: Einzeiliger Kommentar
//Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)
Das obige Beispiel enthält zwei einzeilige Kommentare:
// Beispielprogramm // speichert 3.14 in der Variablen pi
2. Mehrzeiliger Kommentar
Wenn Ihr Kommentar mehrere Zeilen enthält, können Sie ihn einschließen /*… */.
Mehrzeilige Kommentare beginnen mit einem Schrägstrich gefolgt von einem Sternchen ( /*) und enden mit einem Sternchen gefolgt von einem Schrägstrich ( */). Alles dazwischen /*und */wird vom schnellen Compiler ignoriert.
/ * Dies ist ein mehrzeiliger Kommentar. Nachdem Sie einen mehrzeiligen Kommentar geschrieben haben, fügen Sie * gefolgt von / hinzu, um ihn zu beenden * /
Beispiel 2: Mehrzeiliger Kommentar
/* 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)
Das obige Beispiel enthält einen mehrzeiligen Kommentar.
/ * Der fest codierte pi-Wert ist möglicherweise weniger genau. Sie können also mithilfe eingebauter Datentypen für einen genaueren Wert * / berechnen
Dinge, an die man sich erinnern sollte
Obwohl Kommentare sinnvoll sind, um die Absicht des geschriebenen Codes besser zu verstehen. Hier sind Dinge, die Sie beim Schreiben beachten müssen:
- Fügen Sie // keine Kommentare in mehrzeilige Zeilen ein, obwohl diese gültig sind und der Compiler diese Zeilen ignoriert. Fügen Sie es stattdessen in einen mehrzeiligen Kommentar ein.
/*… */
Beispiel:// Dies ist ein Kommentar. // Benutze es wenn nötig und genau
Die obige Methode zum Schreiben von Kommentaren ist korrekt, wird jedoch nicht empfohlen, da Sie mehrzeilige Kommentare schreiben müssen, wenn der Kommentar größer als eine Zeile ist. Der bessere Weg zu schreiben ist die Verwendung eines mehrzeiligen Kommentars als:/ * Dies ist ein Kommentar. Verwenden Sie es bei Bedarf und genau * /
- Einzeiliger Kommentar kann in einer separaten Zeile oder zusammen mit Code in derselben Zeile geschrieben werden. Es wird jedoch empfohlen, Kommentare in einer separaten Zeile zu verwenden.
Beispiel:let pi = 3.14159 // speichert 3.14 in der Variablen pi
Diese Art, Kommentare zu schreiben, ist gültig. Es ist jedoch besser, einen Kommentar in einer separaten Zeile zu schreiben als:// speichert 3.14 in der Variablen pi let pi = 3.14159
- Selbst wenn Sie ein einzelner Entwickler in einem Team sind und der einzige, der den Code schreibt, fällt es Ihnen schwer, seinen Zweck im Programm herauszufinden, wenn er nicht kommentiert ist. Verwenden Sie es also genau und geben Sie eine aussagekräftige Beschreibung.
- Machen Sie einen Kommentar sehr einfach und aussagekräftig.
- Schreiben Sie keine unnötigen Kommentare zu Ihrem Code.
- Verwenden Sie in den meisten Fällen Kommentare, um das Warum und nicht das Wie zu erklären.
