Great, agora eu sei onde encontrar os documentos e como lê-los. Minha próxima pergunta é: Posso criar tal documentação também para o meu código e como eu documento meu código? Quero dizer, dado que eu tenho o seguinte código:

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

Como eu crio uma documentação só para isto package e function?

O formato

Como eu encontrei neste post do blog, parece que não existe “nenhum formato especial” para documentar o código. Comparado com o JavaDoc que introduz coisas novas como @link ou @see. Quando você quer documentar o código, você só tem que criar “comentários simples”. O que você fará de qualquer maneira quando você escrever seu código de go.

Parece que o único requisito é que a primeira palavra deve ser o nome de sua função. Ou Package quando você documenta um 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
}

Gerar o doc

Desculpe dizer, mas você não pode gerar uma documentação! Ou pelo menos não da maneira que eu quero. Eu assumi que posso criar uma documentação em HTML que descreve apenas o meu projeto. Mas você só pode criar uma documentação para todos os arquivos go no seu GOROOT e GOPATH.

Eu criarei outro post sobre o GOPATH mais tarde porque é uma coisa importante no go. Mas, por enquanto, apenas assuma que este é o lugar no seu disco rígido onde você armazena todos os seus arquivos go.

Mas volte para a documentação. Você pode criar um com a ferramenta godoc. Você pode executar godoc -http=:6060 que irá iniciar um webserver no seu localhost na porta 6060 onde você pode ver “os docs”.