Wie man nur einen Teil eines Dokuments in Godocs anzeigen kann

Question

Ich verwende Godocs, um meine in go/golang geschriebene API zu dokumentieren, und dokumentiere sie mit godocs in dem Sinne, dass ich eine HTML-Seite meiner gesamten Hauptdatei erzeuge. Go-Datei, die alle Funktionen zum Erstellen meiner API enthält. Ich möchte jedoch keine Informationen über alle meine Hilfsfunktionen anzeigen. Ich möchte nur Kopfinformationen zu einigen Funktionen in der Datei anzeigen. Gibt es eine Möglichkeit, nur einige der Funktionen in der Datei Teil der Dokumentation zu sein oder muss ich eine andere Datei für alle meine Hilfsfunktionen erstellen? Im Moment habe ich es auf meinem lokalen Port 8000 am Testen: godoc -http=:8000

Answer 1

Das Standard Verhalten der Befehle godoc und sein Cousin go doc, Ausstellverpackung Dokumentation von exportiert Erklärungen. Seltsamer habe ich nicht eine einfache maßgebliche Quelle zu verknüpfen feststellen, dass ausdrücklich auf diese Tatsache dokumentiert, aber es gibt Rückschlüsse auf diese Tatsache in Befehlen verwiesen, die das Standardverhalten, wie aus den godoc package's documentation ändern:

Der Präsentationsmodus von Webseiten, die von godoc bedient werden, können mit dem URL-Parameter "m" gesteuert werden; es akzeptiert eine durch Kommata getrennte Liste von Flag-Namen als Wert:

...

Zum Beispiel http://golang.org/pkg/math/big/?m=all,text zeigt die Dokumentation für alle (nicht nur die exportierten) Erklärungen Paket groß, in Text form (wie es aussehen würde, wenn godoc von der Kommandozeile verwendet würde: "godoc -src math/big. *").

und der Quellcode bei https://golang.org/src/go/doc/doc.go beinhaltet:

81 const (
82  // extract documentation for all package-level declarations, 
83  // not just exported ones 
84  AllDecls Mode = 1 << iota 
... 
89 ) 

Und https://golang.org/src/go/doc/exports.go dokumentiert eine Funktion mit:

241 // fileExports removes unexported declarations from src in place. 

Und schließlich go doc -h im Terminal läuft zeigt eine Flagge:

-u zeigt nicht exportierte Symbole sowie exportiert.