godoc - Online w chmurze

PROGRAM:

IMIĘ

godoc - wyodrębnia i generuje dokumentację dla programów Go

STRESZCZENIE

Godok [flaga] Komenda [ Nazwa ... ]

OPIS

Godoc wyodrębnia i generuje dokumentację dla programów Go.

Posiada dwa tryby.

Bez flagi -http działa w trybie wiersza poleceń i drukuje dokumentację w postaci zwykłego tekstu
na standardowe wyjście i wyjścia. Jeśli zarówno pakiet biblioteki, jak i polecenie o tej samej nazwie
istnieje, użycie przedrostka cmd/ wymusi dokumentację polecenia, a nie
pakiet biblioteczny. Jeśli podano flagę -src, godoc wyświetla wyeksportowany interfejs a
pakiet w formie źródłowej Go lub implementacja określonej eksportowanej jednostki językowej:

godoc fmt # dokumentacja pakietu fmt
godoc fmt Printf # dokumentacja dla fmt.Printf
godoc cmd/go # wymuś dokumentację dla polecenia go
godoc -src fmt # interfejs pakietu fmt w formie źródłowej Go
godoc -src fmt Printf # implementacja fmt.Printf

W trybie wiersza poleceń flaga -q umożliwia wyszukiwanie zapytań względem godoc działającego jako a
serwer internetowy. Jeśli nie podano adresu serwera z opcją -server, najpierw godoc
próbuje localhost: 6060, a potem http://golang.org.

godoc -q Czytnik
godoc -q matematyka.Grzech
godoc -server=:6060 -q grzech

Z flagą -http działa jako serwer WWW i przedstawia dokumentację jako stronę WWW.

godoc - http=:6060

Domyślnie godoc przegląda pakiety znalezione przez $GOROOT i $GOPATH (jeśli jest ustawione).
Dodatkowe katalogi można określić za pomocą flagi -path, która akceptuje listę dwukropków-
oddzielone ścieżki; ścieżki nieukorzenione odnoszą się do bieżącego katalogu roboczego. Każda ścieżka
jest traktowany jako dodatkowy korzeń dla pakietów w kolejności ich pojawienia się. Ostatni
(bezwzględny) element ścieżki jest przedrostkiem ścieżki pakietu. Na przykład, biorąc pod uwagę flagę
wartość:

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

dla godoc uruchomionego w /home/user/godoc, ścieżki bezwzględne są mapowane na ścieżki pakietów jako
następuje:

/home/użytkownik/godoc/x -> godoc/x
/home/bar/x -> bar/x
/publiczne/x -> publiczne/x

Kiedy godoc działa jako serwer WWW i jest ustawione -index, utrzymywany jest indeks wyszukiwania. Indeks
jest tworzony przy starcie.

Indeks zawiera zarówno identyfikator, jak i informacje o wyszukiwaniu pełnotekstowym (można je przeszukiwać za pomocą
wyrażenia regularne). Maksymalną liczbę wyświetlanych wyników wyszukiwania pełnotekstowego można ustawić za pomocą
flaga -maxresults; jeśli jest ustawiony na 0, nie są pokazywane wyniki pełnotekstowe, a tylko identyfikator
indeks, ale nie jest tworzony indeks wyszukiwania pełnotekstowego.

Tryb prezentacji stron internetowych obsługiwanych przez godoc można kontrolować za pomocą adresu URL „m”
parametr; przyjmuje jako wartość listę nazw flag oddzielonych przecinkami:

cała kolekcja pokaż dokumentację dla wszystkich deklaracji, nie tylko tych wywożonych

metody
pokaż wszystkie osadzone metody, nie tylko te z niewyeksportowanych pól anonimowych

src pokaż oryginalny kod źródłowy, a nie wyodrębnioną dokumentację

XNUMX prezentować stronę w formie tekstowej (wiersza poleceń), a nie HTML

mieszkanie prezentuj płaskie (bez wcięcia) wykazy katalogów przy użyciu pełnych ścieżek

Na przykład, http://golang.org/pkg/math/big/?m=all,tekst pokazuje dokumentację dla wszystkich
(nie tylko eksportowane) deklaracje paczki duże, w formie tekstowej (jak by się wydawało
podczas używania godoc z wiersza poleceń: "godoc -src math/big .*").

Domyślnie godoc obsługuje pliki z systemu plików bazowego systemu operacyjnego. Zamiast tego plik .zip
plik może być dostarczony przez flagę -zip, która zawiera system plików do obsługi. Plik
ścieżki przechowywane w pliku .zip muszą używać ukośnika („/”) jako separatora ścieżki; i muszą być
nieukorzenione. $GOROOT (lub -goroot) musi być ustawiony na ścieżkę katalogu pliku .zip zawierającą
Przejdź do katalogu głównego. Na przykład dla pliku .zip utworzonego poleceniem:

zip go.zip $HOME/go

Goddoc można prowadzić w następujący sposób:

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

Zobacz „Godoc: dokumentowanie kodu Go”, aby dowiedzieć się, jak pisać dobre komentarze do godoc:
http://golang.org/doc/articles/godoc_documenting_go_code.html

OPCJE

-v tryb gadatliwy

-q argumenty są uważane za zapytania wyszukiwania: zapytanie prawne to pojedynczy identyfikator (np
jako ToLower) lub kwalifikowany identyfikator (np. math.Sin).

-src drukuj (wyeksportowane) źródło w trybie wiersza poleceń

-szerokość tabulacji=4
szerokość zakładek w jednostkach spacji

-sygnatury czasowe=prawda
pokaż znaczniki czasu z wykazami katalogów

-indeks włącz identyfikator i indeks wyszukiwania pełnotekstowego (brak pola wyszukiwania, jeśli -indeks to
nie ustawiony)

-index_files = ""
wzorzec glob określający pliki indeksowe; jeśli nie jest pusty, indeks jest odczytywany z tych
pliki posortowane

-indeks_przepustnicy=0.75
indeks wartości przepustnicy; wartość 0 oznacza, że ​​indeksatorowi nie przydzielono czasu (
indeksator nigdy się nie zakończy), wartość 1.0 oznacza, że ​​tworzenie indeksu jest uruchomione w
pełna przepustnica (inne gorutyny mogą nie uzyskać czasu podczas budowania indeksu)

-write_index=fałsz
zapisz indeks do pliku; nazwa pliku musi być określona z -index_files

-maksymalne wyniki=10000
maksymalna liczba wyświetlanych wyników wyszukiwania pełnotekstowego (nie jest tworzony indeks pełnotekstowy, jeśli
maxwyniki <= 0)

-ścieżka =""
dodatkowe katalogi pakietów (oddzielone dwukropkami)

-html drukuj HTML w trybie wiersza poleceń

-goroot=$GOROOT
Przejdź do katalogu głównego

-http=adres
Adres usługi HTTP (np. „127.0.0.1:6060” lub po prostu „:6060”)

-serwer=adres
adres serwera WWW do wyszukiwania w wierszu poleceń

-szablony=""
katalog zawierający alternatywne pliki szablonów; jeśli jest ustawiony, katalog może zawierać
alternatywne pliki szablonów dla plików w $GOROOT/lib/godoc

-url=ścieżka
wypisz na standardowe wyjście dane, które byłyby obsługiwane przez żądanie HTTP dla ścieżki

-zip=""
plik zip zapewniający system plików do obsługi; wyłączone, jeśli puste

Korzystaj z godoc online za pomocą usług onworks.net