Godt, nu ved jeg, hvor jeg kan finde dokumentationen, og hvordan jeg kan læse den. Mit næste spørgsmål er: Kan jeg også oprette en sådan dokumentation for min kode, og hvordan dokumenterer jeg min kode? Jeg mener, givet at jeg har følgende kode:

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

Hvordan opretter jeg en dokumentation kun for denne package og function?

formatet

Som jeg fandt i dette blogindlæg ser det ud til, at der ikke er “noget særligt format” til at dokumentere koden. Sammenlignet med JavaDoc, som introducerer nye ting som @link eller @see. Når man ønsker at dokumentere kode skal man blot oprette “simple kommentarer”. Hvad du alligevel vil gøre, når du skriver din go-kode.

Det ser ud til, at det eneste krav, der stilles, er, at det første ord skal være navnet på din funktion. Eller Package når du dokumenterer en 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
}

Generer dokumentationen

Sorry to say, men du kan ikke generere en dokumentation! Eller i hvert fald ikke på den måde, som jeg ønsker det. Jeg gik ud fra, at jeg kan oprette en dokumentation i HTML, som kun beskriver mit projekt. Men du kan kun oprette en dokumentation for alle go-filer i din GOROOT og GOPATH.

Jeg vil oprette et andet indlæg om GOPATH senere, fordi det er en vigtig ting i go. Men indtil videre skal du bare antage, at det er det sted på din harddisk, hvor du gemmer alle dine go-filer.

Men tilbage til dokumentationen. Du kan oprette en med værktøjet godoc. Du kan køre godoc -http=:6060, som vil starte en webserver på din localhost på port 6060, hvor du kan se “the docs”.