Nagyszerű, most már tudom, hol találom a dokumentumokat és hogyan olvashatom őket. A következő kérdésem az lenne, hogy a saját kódomhoz is tudok-e ilyen dokumentációt készíteni és hogyan dokumentálom a kódomat? Úgy értem, adott a következő kódom:

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

Hogyan készíthetek dokumentációt csak ehhez a package és function kódhoz?

A formátum

Amint ebben a blogbejegyzésben találtam, úgy tűnik, hogy “nincs speciális formátum” a kód dokumentálására. A JavaDoc-hoz képest, amely új dolgokat vezet be, mint például @link vagy @see. Ha kódot akarsz dokumentálni, akkor csak “egyszerű megjegyzéseket” kell létrehoznod. Amit egyébként is meg fogsz tenni, amikor megírod a go kódodat.

Úgy tűnik, hogy az egyetlen követelmény az, hogy az első szó a függvényed neve legyen. Vagy Package amikor dokumentálsz egy 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
}

Generáld a dokumentációt

Szomorúan mondom, de nem tudsz dokumentációt generálni! Vagy legalábbis nem úgy, ahogy én szeretném. Feltételeztem, hogy létrehozhatok egy dokumentációt HTML-ben, ami csak a projektemet írja le. De csak a GOROOT és GOPATH összes go fájlodhoz tudsz dokumentációt készíteni.

A GOPATH-ról majd később készítek egy másik bejegyzést, mert ez egy fontos dolog a go-ban. De most csak feltételezzük, hogy ez az a hely a merevlemezeden, ahol az összes go fájlodat tárolod.

De vissza a dokumentációhoz. A godoc eszközzel hozhatsz létre egyet. Futtathatod a godoc -http=:6060, ami elindít egy webszerver a localhoston a 6060-as porton, ahol láthatod “a dokumentációt”.