馃 Godoc

La documentaci贸n es una parte importante en la creaci贸n de programas y se vuelve mas importante conforme estos se van volviendo mas complejos. Golang tiene un excelente soporte para la escritura de dicha documentaci贸n.

Para visualizar la documentaci贸n en Go, utilizamos godoc, que permite desplegar los comentarios que se crean alrededor del c贸digo.

Aunque godoc es la herramienta oficial para este prop贸sito, requiere que se instale manualmente.

馃嵖 驴C贸mo instalar godoc?

$ go get golang.org/x/tools/cmd/godoc

馃嵖 驴C贸mo ver la documentaci贸n de un archivo en Go?

$ godoc archivo.go

La herramienta godoc puede exportar la documentaci贸n a diferentes formatos como html. La documentaci贸n oficial de Go es incluso extra铆da mediante godoc. Cuando ya se encuentre instalado, podemos revisar la documentaci贸n de los paquetes haciendo referencia a estos.

godoc math

Incluso se puede abrir la documentaci贸n de Golang creando un servidor web.

$ godoc -http=":6060"