Wie Server einfache Dokumentation für Go-Programme mit Godoc als Webseite Server?

Question

Ich habe versucht, eine bestimmte lokale Go-Datei als Dokumentationswebseite zu liefern, war aber nicht dazu in der Lage.

Die official godoc documentation sagt:

Mit dem -http Flag (das heißt der godoc Befehl), es läuft als Web-Server und stellt die Dokumentation als Webseite.

user_me$ godoc -http=:6060 

Dies macht etwas Ähnliches wie unterwegs Seite erstellen, aber es ist nicht die bestimmte Datei machen, die ich machen möchte. Also versuchte ich den Namen der Datei zur Verfügung gestellt ich wollte:

user_me$ godoc -http=:6000 hello.go 

jedoch antwortet sie nur 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 habe 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 auch nur versucht, die Erzeugung der HTML-Sache selbst:

godoc -html hello.go > hello.html 

gleichen Fehler wie oben.

Ich habe auch versucht (da es beschwerte sich, dass es keine Datei im PKG dir war):

godoc -html -goroo=$GOPATH hello.go > hello.html 

Am Ende gab ich auf. Ich weiß nicht, wie diese Godoc-Sache funktioniert. Ich habe das hello.go-Programm installiert, so dass ich etwas in der pkg-Datei im Arbeitsbereich hatte. Wie generieren Sie eine Webseite mit Ihrer Dokumentation für Ihren Code?

Answer 1

godoc arbeitet mit Paket- und Typnamen, nicht mit Dateinamen.

Zum Beispiel über io/ioutil Paket zu lernen:

• Textausgabe: godoc io/ioutil

• nur die ReadAll Funktion: godoc io/ioutil ReadAll

• in HTML: godoc -html io/ioutil ReadAll

• in das br owser:

  • godoc -http=:6060
  • Klick Pakete und
  • von dort navigieren oder direkt zu http://localhost:6060/pkg/io/ioutil#ReadAll

Um Dokumentation zu Ihrem eigenen Code zu sehen, hat es in Ihrem aufgenommen werden GOPATH.

Angenommen, Ihr GOPATH umfasst $HOME/go/src, und die Datei, die Sie in interessiert sind $HOME/go/src/hey/world/doc.go, würden Sie laufen:

godoc hey/world 

... oder godoc in HTTP-Modus starten und wechseln Sie zu http://localhost:6060/pkg/hey/world

Answer 2

Sie können verwenden Sie einfach etwas wie: godoc -http=:6060 -path="/path/to/your-code" wo /path/to/your-code enthält Ihre Pakete.

Von dort gehen zu http://localhost:6060/pkg/your-code um Ihre Pakete

Answer 3

standardmäßig zu durchsuchen, godoc schaut auf die Pakete es über $ GOROOT und $ GOPATH findet. Gegeben, so dass Ihr Paket ist in Go Arbeitsplatz d.h in GOPATH, können Sie

godoc fmt

laufen die Dokumentation ausdruckt für fmt-Paket.

Wenn Sie Dokumente generieren für Ihr Paket foo, die in $GOPATH/src/github.com/abcd/foo Lage ist wollen, sollten Sie

godoc github.com/abcd/foo

Mit der -http Flagge laufen, läuft godoc als Web-Server und stellt die Dokumentation als Web Seite.

godoc -http=:6060

Jetzt http://localhost:6060/pkg/github.com/abcd/foo in Browser navigieren docs als Web-Seite zu finden.

Das Flag -play kann verwendet werden, um den Spielplatz im Webinterface zu aktivieren.