Gut, jetzt weiß ich, wo ich die Doku finde und wie ich sie lesen kann. Meine nächste Frage ist: Kann ich eine solche Dokumentation auch für meinen Code erstellen und wie dokumentiere ich meinen Code? Ich meine, wenn ich den folgenden Code habe:

package matherfunc Add(first, second int) int {
return first + second
}

Wie erstelle ich eine Dokumentation nur für diesen package und function?

Das Format

Wie ich in diesem Blogbeitrag gefunden habe, scheint es „kein spezielles Format“ für die Dokumentation des Codes zu geben. Im Vergleich zum JavaDoc, das neue Dinge wie @link oder @see einführt. Wenn Sie Code dokumentieren wollen, müssen Sie nur „einfache Kommentare“ erstellen. Was Sie sowieso tun werden, wenn Sie Ihren Go-Code schreiben.

Es scheint, dass die einzige Anforderung darin besteht, dass das erste Wort der Name Ihrer Funktion sein sollte. Oder Package wenn du eine package dokumentierst.

// Package which provides some math methods
package mather// Add the first and second integer together 
// and return it
func Add(first, second int) int {
return first + second
}

Generate the doc

Es tut mir leid, das zu sagen, aber du kannst keine Dokumentation generieren! Zumindest nicht auf die Art und Weise, wie ich es möchte. Ich bin davon ausgegangen, dass ich eine Dokumentation in HTML erstellen kann, die nur mein Projekt beschreibt. Aber Sie können nur eine Dokumentation für alle Go-Dateien in Ihren GOROOT und GOPATH erstellen.

Ich werde später einen weiteren Beitrag über die GOPATH verfassen, weil es eine wichtige Sache in Go ist. Aber für den Moment nehmen Sie einfach an, dass dies der Ort auf Ihrer Festplatte ist, wo Sie alle Ihre Go-Dateien speichern.

Aber zurück zur Dokumentation. Sie können eine mit dem Werkzeug godoc erstellen. Sie können godoc -http=:6060 ausführen, was einen Webserver auf Ihrem localhost an Port 6060 startet, wo Sie „die Dokumente“ sehen können.