So kommentieren Sie in der Go-Sprache

Go-Sprachkommentarmethode: 1. Implementieren Sie einzeilige Kommentare, indem Sie das „//“-Symbol vor der einzeiligen go-Anweisung platzieren. 2. Umgeben Sie das Go-Codesegment, das auskommentiert werden muss, mit „/*“. ..*/"-Symbole Implementieren Sie mehrzeilige Kommentare.

Die Umgebung dieses Artikels: Windows 7-System, Go1.11.2-Version, dieser Artikel gilt für alle Computermarken.

Empfohlen: „go Language Tutorial“

Die Rolle von Kommentaren im Programm besteht darin, das Programm zu kommentieren und zu erklären, um das Lesen des Quellcodes zu erleichtern. Das Kompilierungssystem ignoriert den kommentierten Teil beim Kompilieren des Quellcodes automatisch, sodass die Kommentare bei der Realisierung der Funktion des Programms keine Rolle spielen. Durch entsprechendes Hinzufügen von Kommentaren zum Quellcode kann die Lesbarkeit des Quellcodes verbessert werden.

Kommentare in der Go-Sprache werden hauptsächlich in zwei Kategorien unterteilt, nämlich einzeilige Kommentare und mehrzeilige Kommentare.

Einzeilige Kommentare werden als Zeilenkommentare bezeichnet, die die häufigste Form von Kommentaren sind, die mit // beginnen und überall verwendet werden können.

Mehrzeilige Kommentare werden als Blockkommentare bezeichnet mit /* und endend mit */, und Es kann nicht verschachtelt werden. Mehrzeilige Kommentare werden im Allgemeinen für Paketdokumentationsbeschreibungen oder Codeausschnitte verwendet, die in Blöcken kommentiert werden.

Das Format eines einzeiligen Kommentars ist wie folgt

//单行注释

Das Format eines mehrzeiligen Kommentars ist wie folgt:

/*
第一行注释
第二行注释
...
*/

Jedes Paket sollte entsprechende Kommentare enthalten, bevor die Paketanweisung zum Deklarieren des Paketnamens verwendet wird um das Paket zu identifizieren. Beschreiben Sie kurz die Funktionen und Funktionen.

Gleichzeitig wird der Kommentarinhalt vor der Paketanweisung standardmäßig als Dokumentation dieses Pakets betrachtet. Ein Paket kann auf mehrere Dateien verteilt sein, es muss jedoch nur eine davon kommentiert werden.

Sie können Leerzeilen verwenden, um mehrere Kommentare zu trennen, wie unten gezeigt:

// Package superman implements methods for saving the world.
//
// Experience has shown that a small number of procedures can prove
// helpful when attempting to save the world.
package superman

Es ist am besten, entsprechende Kommentare zu Variablen, Konstanten, Funktionen und anderen Objekten im Code hinzuzufügen, was die spätere Entwicklung des Codes erleichtert , wie zum Beispiel die Kommentare zur enterOrbit-Funktion im folgenden Code:

// enterOrbit causes Superman to fly into low Earth orbit, a position
// that presents several possibilities for planet salvation.
func enterOrbit() error {
   ...
}

Wenn Entwickler etwas über das Paket wissen müssen, können sie godoc verwenden, um die Dokumentation des Pakets anzuzeigen

Weitere verwandte technische Artikel finden Sie unter Golang-Tutorial Spalte!

Das obige ist der detaillierte Inhalt vonSo kommentieren Sie in der Go-Sprache. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!