Genial, nu vet jag var jag hittar dokumentationen och hur jag ska läsa den. Min nästa fråga är: Kan jag skapa en sådan dokumentation även för min kod och hur dokumenterar jag min kod? Jag menar, givet att jag har följande kod:

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

Hur skapar jag en dokumentation bara för denna package och function?

Formatet

Som jag hittade i det här blogginlägget verkar det som om det inte finns ”något speciellt format” för att dokumentera koden. Jämfört med JavaDoc som inför nya saker som @link eller @see. När man vill dokumentera kod behöver man bara skapa ”enkla kommentarer”. Vad du ändå gör när du skriver din go-kod.

Det verkar som om det enda kravet är att det första ordet ska vara namnet på din funktion. Eller Package när du dokumenterar 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
}

Generera dokumentationen

Ledsen att behöva säga det, men du kan inte generera en dokumentation! Eller åtminstone inte på det sätt som jag vill. Jag antog att jag kan skapa en dokumentation i HTML som endast beskriver mitt projekt. Men du kan bara skapa en dokumentation för alla go-filer i din GOROOT och GOPATH.

Jag kommer att skapa ett annat inlägg om GOPATH senare eftersom det är en viktig sak i go. Men för tillfället kan du bara anta att detta är platsen på din hårddisk där du lagrar alla dina go-filer.

Men tillbaka till dokumentationen. Du kan skapa en sådan med verktyget godoc. Du kan köra godoc -http=:6060 som kommer att starta en webbserver på ditt localhost på port 6060 där du kan se ”the docs”.