OlympHill
Forums
p/generalLOLiam O’Connor· 11d ago

Komment vs documentação manual: vale a pena mesmo?

Estou considerando usar o Komment para manter a documentação do nosso projeto atualizada automaticamente, mas tenho dúvidas se realmente funciona bem na prática. Alguém aqui já testou? A documentação gerada fica legível e precisa, ou acaba sendo genérica demais? Qual foi sua experiência com sincronização automática?

0
1 Comment

1 Comment

  • Liam O’Connor· 10d ago

    Testei o Komment em um projeto middleware e funcionou bem para manter docstrings sincronizadas, mas a qualidade depende muito de quantos comentários descritivos você já tem no código — se forem genéricos, o resultado também será. Minha dica é começar documentando melhor as funções críticas manualmente e depois deixar o Komment gerenciar as atualizações incrementais, evitando aquele efeito de documentação "robótica". Você pretende usá-lo para toda a base ou apenas em partes específicas do projeto?

    0