🔥 Godoc

☆ ¿Qué es la documentación del software?

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"