Bene, ora so dove trovare la documentazione e come leggerla. La mia prossima domanda è: posso creare una tale documentazione anche per il mio codice e come posso documentare il mio codice? Voglio dire, dato che ho il seguente codice:

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

Come faccio a creare una documentazione solo per questo package e function?

Il formato

Come ho trovato in questo post del blog sembra che non ci sia “un formato speciale” per documentare il codice. Rispetto al JavaDoc che introduce nuove cose come @link o @see. Quando volete documentare il codice dovete solo creare “semplici commenti”. Quello che farete comunque quando scriverete il vostro codice go.

Sembra che l’unico requisito sia che la prima parola sia il nome della vostra funzione. Oppure Package quando documentate un 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
}

Genera la documentazione

Mi dispiace dirlo, ma non potete generare una documentazione! O almeno non nel modo in cui voglio io. Ho pensato che posso creare una documentazione in HTML che descrive solo il mio progetto. Ma puoi creare una documentazione solo per tutti i file go nel tuo GOROOT e GOPATH.

Creerò un altro post sul GOPATH più tardi perché è una cosa importante in go. Ma per ora supponiamo solo che questo sia il posto sul tuo disco rigido dove memorizzi tutti i tuoi file di go.

Ma torniamo alla documentazione. Puoi crearne uno con lo strumento godoc. Puoi eseguire godoc -http=:6060 che avvierà un webserver sul tuo localhost alla porta 6060 dove potrai vedere “la documentazione”.