godoc - Online in de cloud

PROGRAMMA:

NAAM

godoc - extraheert en genereert documentatie voor Go-programma's

KORTE INHOUD

goed [vlag] commando [ naam ... ]

PRODUCTBESCHRIJVING

Godoc extraheert en genereert documentatie voor Go-programma's.

Het heeft twee standen.

Zonder de vlag -http werkt het in de opdrachtregelmodus en drukt het documentatie in platte tekst af
naar standaarduitvoer en uitgangen. Als zowel een bibliotheekpakket als een commando met dezelfde naam
bestaat, zal het gebruik van het voorvoegsel cmd/ documentatie op de opdracht forceren in plaats van de
bibliotheek pakket. Als de vlag -src is opgegeven, drukt godoc de geëxporteerde interface van a . af
pakket in Go-bronvorm, of de implementatie van een specifieke geëxporteerde taalentiteit:

godoc fmt # documentatie voor pakket fmt
godoc fmt Printf # documentatie voor fmt.Printf
godoc cmd/go # forceer documentatie voor het go-commando
godoc -src fmt # fmt pakketinterface in Go-bronvorm
godoc -src fmt Printf # implementatie van fmt.Printf

In de opdrachtregelmodus maakt de vlag -q zoekopdrachten mogelijk tegen een godoc die wordt uitgevoerd als a
web Server. Als er geen expliciet serveradres is opgegeven met de vlag -server, godoc eerst
probeert localhost:6060 en dan http://golang.org.

godoc -q Lezer
godoc -q wiskunde.Sin
godoc -server=:6060 -q zonde

Met de vlag -http werkt het als een webserver en presenteert het de documentatie als een webpagina.

godoc -http=:6060

Standaard kijkt godoc naar de pakketten die het vindt via $GOROOT en $GOPATH (indien ingesteld).
Extra mappen kunnen worden opgegeven via de vlag -path die een lijst met dubbele punten accepteert
gescheiden paden; niet-geroote paden zijn relatief ten opzichte van de huidige werkdirectory. elk pad
wordt beschouwd als een extra root voor pakketten in volgorde van verschijnen. De laatste
(absoluut) padelement is het voorvoegsel voor het pakketpad. Bijvoorbeeld, gezien de vlag
waarde:

path=".:/home/bar:/public"

voor een godoc die is gestart in /home/user/godoc, worden absolute paden toegewezen aan pakketpaden als
volgt:

/home/user/godoc/x -> godoc/x
/home/bar/x -> bar/x
/public/x -> public/x

Wanneer godoc als webserver draait en -index is ingesteld, wordt een zoekindex bijgehouden. De index
wordt aangemaakt bij het opstarten.

De index bevat zowel identificatiegegevens als zoekinformatie in volledige tekst (doorzoekbaar via
normale uitdrukkingen). Het maximum aantal getoonde full text zoekresultaten kan worden ingesteld met
de vlag -maxresults; indien ingesteld op 0, worden er geen volledige tekstresultaten weergegeven en alleen een identifier
index, maar er wordt geen zoekindex voor volledige tekst gemaakt.

De presentatiemodus van webpagina's die door godoc worden bediend, kan worden beheerd met de "m" URL
parameter; het accepteert een door komma's gescheiden lijst met vlagnamen als waarde:

allen toon documentatie voor alle aangiften, niet alleen de geëxporteerde

methoden
toon alle ingesloten methoden, niet alleen die van niet-geëxporteerde anonieme velden

src toon de originele broncode in plaats van de uitgepakte documentatie

tekst presenteer de pagina in tekstuele (opdrachtregel) vorm in plaats van HTML

plat presenteer platte (niet ingesprongen) directorylijsten met volledige paden

Bijvoorbeeld, http://golang.org/pkg/math/big/?m=all,text toont de documentatie voor iedereen
(niet alleen de geëxporteerde) aangiften van pakket groot, in tekstvorm (zoals het lijkt)
bij gebruik van godoc vanaf de opdrachtregel: "godoc -src math/big .*").

Godoc dient standaard bestanden uit het bestandssysteem van het onderliggende besturingssysteem. In plaats daarvan een .zip
bestand kan worden aangeleverd via de vlag -zip, die het te bedienen bestandssysteem bevat. Het bestand
paden die zijn opgeslagen in het .zip-bestand moeten een slash ('/') als padscheidingsteken gebruiken; en dat moeten ze zijn
ongeworteld. $GOROOT (of -goroot) moet worden ingesteld op het .zip-bestandsdirectorypad met daarin de
Ga naar de hoofdmap. Bijvoorbeeld voor een .zip-bestand dat is gemaakt met de opdracht:

zip go.zip $HOME/go

men kan godoc als volgt uitvoeren:

godoc -http=:6060 -zip=go.zip -goroot=$HOME/go

Zie "Godoc: Go-code documenteren" voor het schrijven van goede opmerkingen voor godoc:
http://golang.org/doc/articles/godoc_documenting_go_code.html

OPTIES

-v uitgebreide modus

-q argumenten worden beschouwd als zoekopdrachten: een juridische zoekopdracht is een enkele identifier (zoals
als ToLower) of een gekwalificeerde identifier (zoals math.Sin).

-src print (geëxporteerde) bron in opdrachtregelmodus

-tabbreedte=4
breedte van tabbladen in eenheden van spaties

-timestamps=waar
toon tijdstempels met directoryvermeldingen

-inhoudsopgave identifier en full-text zoekindex inschakelen (er wordt geen zoekvak weergegeven als -index is
niet ingesteld)

-index_files=""
glob patroon dat indexbestanden specificeert; indien niet leeg, wordt de index hieruit gelezen
bestanden in gesorteerde volgorde

-index_throttle=0.75
index gaspedaal waarde; een waarde van 0 betekent dat er geen tijd wordt toegewezen aan de indexeerder (de
indexer zal nooit eindigen), een waarde van 1.0 betekent dat het maken van de index wordt uitgevoerd op
vol gas (andere goroutines krijgen misschien geen tijd terwijl de index wordt gebouwd)

-write_index=onwaar
schrijf index naar een bestand; de bestandsnaam moet worden opgegeven met -index_files

-maxresultaten=10000
maximum aantal full text zoekresultaten getoond (er wordt geen full text index gebouwd als
maximale resultaten <= 0)

-path=""
extra pakketmappen (gescheiden door dubbele punten)

-html HTML afdrukken in opdrachtregelmodus

-goroot=$GOROOT
Ga naar hoofdmap

-http=adr
HTTP-serviceadres (bijv. '127.0.0.1:6060' of gewoon ':6060')

-server=adres
webserveradres voor zoekopdrachten op de opdrachtregel

-sjablonen=""
map met alternatieve sjabloonbestanden; indien ingesteld, kan de directory bieden:
alternatieve sjabloonbestanden voor de bestanden in $GOROOT/lib/godoc

-url=pad
print naar standaarduitvoer van de gegevens die zouden worden geleverd door een HTTP-verzoek voor pad

-zip=""
zip-bestand dat het bestandssysteem levert om te dienen; uitgeschakeld indien leeg

Gebruik godoc online met onworks.net-services