Wie wollen Sie dienen der einfachen Dokumentation für die go-Programme mit godoc als eine Webseite?
Ich versuche zu dienen, eine bestimmte lokale gehen, die Datei als Dokumentation, web-Seite, aber nicht in der Lage war, es zu tun.
Den offizielle godoc Dokumentation sagt:
Mit der-http-flag (d.h. die godoc Befehl), es läuft als web-server und stellt die Dokumentation als web-Seite.
user_me$ godoc -http=:6060
Dies bedeutet etwas ähnliches wie die Seite Los ist, aber es nicht dazu, dass die spezifische Datei, die ich Rendern möchten. So habe ich versucht, geben Sie den Namen der Datei, die ich wollte:
user_me$ godoc -http=:6000 hello.go
Allerdings nur Antworten mit:
usage: godoc package [name ...]
godoc -http=:6060
-ex=false: show examples in command line mode
-goroot="/usr/local/go": Go root directory
-html=false: print HTML in command-line mode
-http="": HTTP service address (e.g., ':6060')
-httptest.serve="": if non-empty, httptest.NewServer serves on this address and blocks
-index=false: enable search index
-index_files="": glob pattern specifying index files;if not empty, the index is read from these files in sorted order
-index_throttle=0.75: index throttle value; 0.0 = no time allocated, 1.0 = full throttle
-links=true: link identifiers to their declarations
-maxresults=10000: maximum number of full text search results shown
-notes="BUG": regular expression matching note markers to show
-play=false: enable playground in web interface
-q=false: arguments are considered search queries
-server="": webserver address for command line searches
-src=false: print (exported) source in command-line mode
-tabwidth=4: tab width
-templates="": directory containing alternate template files
-timestamps=false: show timestamps with directory listings
-url="": print HTML for named URL
-v=false: verbose mode
-write_index=false: write index to a file; the file name must be specified with -index_files
-zip="": zip file providing the file system to serve; disabled if empty
Ich auch versucht:
user_me$ godoc -url="localhost:8080" hello.go
aber es hat nicht funktioniert.
Ich auch versucht:
godoc -server=localhost:8080 hello.go
aber es antwortete mit:
2014/07/01 10:45:56 open /usr/local/go/src/pkg/hello.go: no such file or directory
Ich habe sogar versucht nur die Generierung der html-Sache selbst:
godoc -html hello.go > hello.html
gleichen Fehler wie oben.
Ich habe auch versucht (da war es beklagen, dass es keine Datei in der pkg-dir):
godoc -html -goroo=$GOPATH hello.go > hello.html
Am Ende, ich gab auf. Ich weiß nicht, wie diese godoc Ding funktioniert. Ich installierte die Hallo.gehen Sie das Programm so, dass ich es war etwas in der pkg Datei in den Arbeitsbereich. Wie Sie erstellen eine Webseite mit Ihren Unterlagen für Ihren code?
Du musst angemeldet sein, um einen Kommentar abzugeben.
godoc arbeitet auf Paket-und Art-Namen, nicht die Dateinamen.
Zum Beispiel, zu lernen, über
io/ioutil
Paket:text-Ausgabe:
godoc io/ioutil
nur die
ReadAll
Funktion:godoc io/ioutil ReadAll
in HTML:
godoc -html io/ioutil ReadAll
im browser:
godoc -http=:6060
http://localhost:6060/pkg/io/ioutil#ReadAll
Zum anzeigen der Dokumentation für Ihren eigenen code, es hat in den
GOPATH
.Angenommen, Ihr
GOPATH
umfasst$HOME/go/src
, und die Datei, die Sie daran interessiert sind, ist$HOME/go/src/hey/world/doc.go
Sie laufen würde:...oder starten godoc im HTTP-Modus und navigieren Sie zu
http://localhost:6060/pkg/hey/world
hey/world
ich habe nurCOMMAND DOCUMENTATION
- und das ist es, sonst nichts. Wenn Sie sagen, beginnen godoc und ich gehe auf die Seite sehe ich die Namen der repo, aber es nicht in die Dokumentation für meine nur Hallo.gehen Programm. Warum ist das so?package main
); in diesem Fall zeigt es nur die Paket-Ebene Kommentar. Ein Beispiel finden Sie unter golang.org/src/cmd/gofmt/doc.gogodoc -http=:6060
bietet Ihnen die gesamte Dokumentation einschließlich der standard-Bibliotheken und Ihre eigenen Pakete. Und die meisten buttons im browser angezeigt werden nicht entsprechenden code (wie "Dokumente", "Projekt", "Hilfe", etc)Standardmäßig godoc sieht der Pakete findet über $GOROOT und $GOPATH. So gegeben, dass Ihr Paket ist in der Go-Arbeitsbereich ich.e in GOPATH, die Sie ausführen können,
godoc fmt
dem Drucke Dokumentation für das fmt-Paket.
Wenn Sie wollen, zu generieren docs für Ihr Paket
foo
die in$GOPATH/src/github.com/abcd/foo
Lage, führen Siegodoc github.com/abcd/foo
Mit der
-http
Flagge, godoc läuft als web-server und stellt die Dokumentation als web-Seite.godoc -http=:6060
Navigieren Sie nun zu
http://localhost:6060/pkg/github.com/abcd/foo
im browser zu finden docs als Webseite.Den
-play
- flag kann verwendet werden, um zu ermöglichen, Spielplatz web-interface.Zeigen HTML-doc erzeugt für Ihre eigenen code
Schritt 1) An der Kommandozeile starten Sie den Dokument-web-server, das ist:
C:\>godoc -http=:6060
Step 2) Öffne einen browser und verwenden Sie eine explizite url, die den Ordner code.
Die URL-Struktur kommt aus dem Ordner-Namen unter Ihre GOPATH.
Beispiel:
Wenn mein GOPATH ist
c:\go
und ich habe den code inc:\go\src\myfolder\mysubfolder
Die URL würde ich verwendet ist
http://localhost:6060/pkg/myfolder/mysubfolder
und dies würde zeigen, eine HTML-Seite für die .gehen Dateien inAußerdem können Sie URL -
http://localhost:6060/pkg/myfolder
haben, die einen link zumysubfolder
Hinweise:
http://localhost:6060/pkg
Ebene, können Sie vielleicht nichtsrc
Ordner, siehe https://blog.golang.org/godoc-documenting-go-codeKönnen Sie einfach so etwas wie:
godoc -http=:6060 -path="/path/to/your-code"
wo
/path/to/your-code
enthält Ihre Pakete.Gehen Sie von dort zu
http://localhost:6060/pkg/your-code
damit durchsuchen Sie Ihre Paketeflag provided but not defined: -path