Geweldig, nu weet ik waar ik de docs kan vinden en hoe ik ze moet lezen. Mijn volgende vraag is: Kan ik ook zo’n documentatie voor mijn code maken en hoe documenteer ik mijn code? Ik bedoel, gegeven dat ik de volgende code heb:

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

Hoe maak ik een documentatie alleen voor deze package en function?

Het formaat

Zoals ik in deze blog post vond lijkt het erop dat er “geen speciaal formaat” is om de code te documenteren. Vergeleken met de JavaDoc die nieuwe dingen introduceert zoals @link of @see. Wanneer je code wilt documenteren hoef je alleen maar “eenvoudig commentaar” te maken.

Het lijkt erop dat de enige vereiste is dat het eerste woord de naam van je functie is. Of Package wanneer je een package documenteert.

// 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
}

Genereer de doc

Sorry om te zeggen, maar je kunt geen documentatie genereren! Of in ieder geval niet op de manier die ik wil. Ik veronderstelde dat ik een documentatie in HTML kon maken die alleen mijn project beschrijft. Maar je kunt alleen een documentatie maken voor alle go bestanden in je GOROOT en GOPATH.

Ik zal later nog een post maken over de GOPATH omdat het een belangrijk ding is in go. Maar ga er nu maar van uit dat dit de plaats is op uw harde schijf waar u al uw go-bestanden opslaat.

Maar terug naar de documentatie. U kunt er een maken met de godoc tool. U kunt godoc -http=:6060 uitvoeren, dat start een webserver op uw localhost op poort 6060 waar u “de docs” kunt zien.