Grandioso, ahora se donde encontrar los docs y como leerlos. Mi siguiente pregunta es: ¿Puedo crear dicha documentación para mi código también y cómo documento mi código? Quiero decir, dado que tengo el siguiente código:

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

¿Cómo puedo crear una documentación sólo para este package y function?

El formato

Como he encontrado en esta entrada del blog parece que no hay «ningún formato especial» para documentar el código. Comparado con el JavaDoc que introduce cosas nuevas como @link o @see. Cuando quieras documentar código sólo tienes que crear «simples comentarios». Lo que harás de todos modos cuando escribas tu código go.

Parece que el único requisito es que la primera palabra debe ser el nombre de tu función. O Package cuando documentas 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
}

Generar la doc

¡Siento decirlo, pero no puedes generar una documentación! O al menos no de la manera que yo quiero. Supuse que podía crear una documentación en HTML que describiera únicamente mi proyecto. Pero sólo puede crear una documentación para todos los archivos go en su GOROOT y GOPATH.

Crearé otro post sobre el GOPATH más tarde porque es una cosa importante en go. Pero por ahora solo asume que este es el lugar en tu disco duro donde guardas todos tus archivos de go.

Pero volviendo a la documentación. Usted puede crear uno con la herramienta godoc. Puede ejecutar godoc -http=:6060 que iniciará un servidor web en su localhost en el puerto 6060 donde se puede ver «la documentación».