Godoc es una gran herramienta para documentar paquetes, sin embargo, parece ser menos útil cuando se usa contrapackage main. Veré una salida que solo muestra las notas que me he escrito usando//BUG y subdirectorios.

Godoc solo muestra funciones exportadas y parece no tener forma de mostrar funciones / exportaciones no exportadas desde main. Me resultaría útil ver una lista de funciones en main. Como esto no es compatible, tiendo a incluir una lista de funciones en la parte superior de la descripción del paquete, pero esto parece una solución alternativa.

Como tengo que actualizar manualmente la lista de funciones, a menudo pongo tanto código en los paquetes como puedo para que se exporte y, por lo tanto, se documente. ¿Es esta una buena idea? ¿Qué debo hacer sobre la lista de funciones en main?

Ejemplo:

COMMAND DOCUMENTATION

Package main implements a web server, template renderer and DAL for MySQL.

<filename.go>

    <function>(<signature>)

main.go

    main()
    bootstrap() error
    <more functions here>


BUGS

    [filename.go] <whatever...>


SUBDIRECTORIES

    auth
    common
    debug
    storage
    <more packages here>