Godoc é uma ótima ferramenta para documentar pacotes, no entanto, parece ser menos útil quando usado contrapackage main. Vou ver uma saída que exibe apenas as notas que escrevi para mim mesmo usando//BUG e subdiretórios.

Godoc apenas exibe funções exportadas e parece não ter como exibir / não exportadas / funções do main. Eu consideraria útil ver uma lista de funções em main. Como isso não é suportado, tenho a tendência de colocar uma lista de funções na parte superior da descrição do pacote, mas isso parece uma solução alternativa.

Como tenho que atualizar manualmente a lista de funções, geralmente coloco o máximo de código possível nos pacotes para que seja exportado e, portanto, documentado. isso é uma boa ideia? O que devo fazer sobre a lista de funções principal?

Exemplo:

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>