Świetnie, teraz wiem gdzie znaleźć dokumenty i jak je czytać. Moje kolejne pytanie brzmi: Czy mogę stworzyć taką dokumentację również dla mojego kodu i jak udokumentować mój kod? Mam na myśli, biorąc pod uwagę, że mam następujący kod:

package matherfunc Add(first, second int) int {
return first + second
}

Jak mogę stworzyć dokumentację tylko dla tego package i function?

Format

Jak znalazłem w tym wpisie na blogu, wydaje się, że nie ma „żadnego specjalnego formatu” do dokumentowania kodu. W porównaniu z JavaDoc, który wprowadza nowe rzeczy, takie jak @link lub @see. Kiedy chcesz udokumentować kod, musisz tylko stworzyć „proste komentarze”. Co i tak zrobisz, gdy napiszesz swój kod go.

Wydaje się, że jedynym wymaganiem jest to, że pierwsze słowo powinno być nazwą twojej funkcji. Albo Package kiedy dokumentujesz package.

// Package which provides some math methods
package mather// Add the first and second integer together 
// and return it
func Add(first, second int) int {
return first + second
}

Generate the doc

Przykro mi to mówić, ale nie możesz wygenerować dokumentacji! A przynajmniej nie w taki sposób, w jaki ja chcę. Założyłem, że mogę utworzyć dokumentację w HTML, która opisuje tylko mój projekt. Ale możesz utworzyć dokumentację tylko dla wszystkich plików go w twoich GOROOT i GOPATH.

Powstanie kolejny post o GOPATH później, ponieważ jest to ważna rzecz w go. Ale na razie załóżmy, że jest to miejsce na dysku twardym, gdzie przechowujesz wszystkie swoje pliki go.

Ale wracając do dokumentacji. Możesz ją utworzyć za pomocą narzędzia godoc. Możesz uruchomić godoc -http=:6060, które uruchomi serwer WWW na twoim localhost na porcie 6060, gdzie będziesz mógł zobaczyć „dokumentację”.