Go-Code mit Godoc . dokumentieren

Blog

Wie Sie, wenn Sie meinen Blog lesen, wissen, habe ich eine Reihe neuer Dienstprogrammpakete erstellt, damit ich mit der Entwicklung eines Anwendungsservers beginnen kann, den ich für ein neues Projekt benötige. Ich bin ganz neu bei Go und dem Mac OS. Unnötig zu erwähnen, dass es in den letzten Monaten eine verdammt gute Ausbildung war. Aber Windows oder C## vermisse ich überhaupt nicht.



Ich habe einige Fortschritte bei meiner Codierung gemacht und wollte eine Dokumentation für den Code erstellen. Ich habe den Dokumentationsbetrachter in LiteIDE verwendet und hatte gehofft, meine Dokumentation dort gut integrieren zu können. Ich war wirklich überrascht zu sehen, dass LiteIDE meine Pakete bereits in ihrem integrierten Godoc-Viewer aufgelistet hatte. Also stellte sich die Frage. Wie funktioniert das?

Nach einigem Suchen fand ich diese lokale HTML-Datei. Wenn Sie LiteIDE installiert haben, können Sie die folgende URL in Ihren Browser kopieren.



file:///Applications/LiteIDE.app/Contents/Resources/golangdoc/about.html

Das zeigt es



Überblick

Der integrierte Godoc-Viewer in LiteIDE bietet eine einfache Möglichkeit, die vom godoc-Tool erstellte Dokumentation zu durchsuchen, ohne den Editor zu verlassen. Die Dokumentation kann sowohl für die offizielle Go-Sprache als auch für benutzerdefinierte Pakete angezeigt werden. Der Rest dieser Seite beschreibt Möglichkeiten zum Aufrufen des Godoc-Viewers.

Unterstützte URL-Schemata

Es ist möglich, die Dokumentation anzuzeigen, indem Sie direkt eine URL in die Adressleiste des Godoc-Viewers eingeben. Dabei können Sie angeben, nach welcher Art von Dokumentation Sie suchen, indem Sie der Adresse eines der folgenden URL-Schemata voranstellen:

finden

Sucht nach Paketen mit einer angegebenen Zeichenfolge in ihrem Namen. Zum Beispiel:

  • finde:zip
  • finde:godoc

aufführen

Listet alle Pakete in einem bestimmten Verzeichnis auf. Die wichtigsten Auswahlmöglichkeiten sind pkg und cmd, die als Links in der Kopfzeile der Seite zu finden sind. Zum Beispiel:

  • list:pkg - zeigt die Golang-Pakete an
  • list:cmd - zeigt die Golang-Befehle an

pdoc

Zeigt die Dokumentation für ein angegebenes Paket oder einen angegebenen Befehl an. Zum Beispiel:

  • pdoc:fmt
  • pdoc:archiv/zip
  • pdoc:gofmt
  • pdoc:f:/hg/zmq/gozmq

Datei

Zeigt eine angegebene HTML-, Markdown- oder Nur-Text-Datei an. Zum Beispiel:

  • file:c:/go/doc/docs.html

Automatische Schemata

Für die Datei- und Pdoc-Schemas müssen Sie das Schema nicht als Teil der URL eingeben. Zum Beispiel:

  • /doc/code.html
  • /src/pkg
  • /src/cmd
  • /pkg/fmt
  • /cmd/cgo
  • archiv/zip
  • gehen

Dateibrowser

Sie können den Godoc-Viewer direkt aus dem Dateibrowser öffnen, indem Sie mit der rechten Maustaste auf eine Datei oder ein Verzeichnis klicken und Godoc Here anzeigen auswählen. Der Godoc-Viewer öffnet automatisch die Paketdokumentation für den ausgewählten Artikel.

#gehen

www.ardanlabs.com

Go-Code mit Godoc . dokumentieren

Wie Sie, wenn Sie meinen Blog lesen, wissen, habe ich eine Reihe neuer Dienstprogrammpakete erstellt, damit ich mit der Entwicklung eines Anwendungsservers beginnen kann, den ich für ein neues Projekt benötige. Ich bin ganz neu bei Go und dem Mac OS. Unnötig zu erwähnen, dass es in den letzten Monaten eine verdammt gute Ausbildung war. Aber Windows oder C# vermisse ich überhaupt nicht.