Documentação de código é realmente importante?

[ad#texto]
Certa vez participando de uma palestra, o palestrando disse que é besteira o desenvolvedor de software se preocupar em produzir e manter documentação do seu código-fonte.

O mesmo alegava que o trabalho em manter e produzir toda a documentação é muito amplo e desnecessário se o desenvolvedor seguir os padrões de desenvolvimento existentes para a sua plataforma, no caso era uma palestra sobre Java.

Eu pensei muito a respeito, e a minha opinião é totalmente contrária a do palestrante.

Em primeiro lugar, produzir e manter uma documentação no padrão Javadoc, que é o padrão adotado pelo Java, é muito simples e com a ajuda de IDE´s como o Netbeans ou o Eclipse essa tarefa se torna tão modesta que não o pouco tempo que “perdemos” é totalmente recompensado (com lucros) nas futuras manutenções e upgrades do sistema.

A alegação do palestrante de que código-fonte bem produzido é inteligível para qualquer outro desenvolvedor não está errado, mas também não é tão simplista assim.

Por mais purista que o desenvolvedor seja, eu nunca vi em mais de 10 anos um código-fonte que fosse tão inteligível assim, padrões auxiliam e evitam a famosa programação McGuiver (aquela que com o bloco de notas e o Javac fazemos um ERP em dois dias), sempre existe a demanda de tempo e aprendizado sobre o novo código-fonte que vamos alterar ou trocar, e esse tempo é diminuído caso o código-fonte esteja documentado.

Então faça um bem para você e para os demais, documente o seu código-fonte e vamos fazer do desenvolvimento de software um lugar mais feliz!

Aproveitante, se alguém algum dia encontrar um código-fonte tão perfeito  como o citado pelo palestrante, por favor em envie, pois vou emoldurar e pendurar na parede do meu quarto.

Certa vez participando de uma palestra, o palestrando disse que é besteira o desenvolvedor de software se preocupar em produzir e manter documentação do seu código-fonte.

O mesmo alegava que o trabalho em manter e produzir toda a documentação é muito amplo e desnecessário se o desenvolvedor seguir os padrões de desenvolvimento existentes para a sua plataforma, no caso era uma palestra sobre Java.

Eu pensei muito a respeito, e a minha opinião é totalmente contrária a do palestrante.

Em primeiro lugar, produzir e manter uma documentação no padrão Javadoc, que é o padrão adotado pelo Java, é muito simples e com a ajuda de IDE´s como o Netbeans ou o Eclipse essa tarefa se torna tão modesta que não o pouco tempo que “perdemos” é totalmente recompensado (com lucros) nas futuras manutenções e upgrades do sistema.

A alegação do palestrante de que código-fonte bem produzido é inteligível para qualquer outro desenvolvedor não está errado, mas também não é tão simplista assim.

Por mais purista que o desenvolvedor seja, eu nunca vi em mais de 1

Certa vez participando de uma palestra, o palestrando disse que é besteira o desenvolvedor de software se preocupar em produzir e manter documentação do seu código-fonte.

O mesmo alegava que o trabalho em manter e produzir toda a documentação é muito amplo e desnecessário se o desenvolvedor seguir os padrões de desenvolvimento existentes para a sua plataforma, no caso era uma palestra sobre Java.

Eu pensei muito a respeito, e a minha opinião é totalmente contrária a do palestrante.

Em primeiro lugar, produzir e manter uma documentação no padrão Javadoc, que é o padrão adotado pelo Java, é muito simples e com a ajuda de IDE´s como o Netbeans ou o Eclipse essa tarefa se torna tão modesta que não o pouco tempo que “perdemos” é totalmente recompensado (com lucros) nas futuras manutenções e upgrades do sistema.

A alegação do palestrante de que código-fonte bem produzido é inteligível para qualquer outro desenvolvedor não está errado, mas também não é tão simplista assim.

Por mais purista que o desenvolvedor seja, eu nunca vi em mais de 10 anos um código-fonte que fosse tão inteligível assim, padrões auxiliam e evitam a famosa programação McGuiver (aquela que com o bloco de notas e o Javac fazemos um ERP em dois dias), sempre existe a demanda de tempo e aprendizado sobre o novo código-fonte que vamos alterar ou trocar, e esse tempo é diminuído caso o código-fonte esteja documentado.

Então faça um bem para você e para os demais, documente o seu código-fonte e vamos fazer do desenvolvimento de software um lugar mais feliz!

Aproveitante, se alguém algum dia encontrar um código-fonte tão perfeito  como o citado pelo palestrante, por favor em envie, pois vou emoldurar e pendurar na parede do meu quarto.

0 anos um código-fonte que fosse tão inteligível assim, padrões auxiliam e evitam a famosa programação McGuiver (aquela que com o bloco de notas e o Javac fazemos um ERP em dois dias), sempre existe a demanda de tempo e aprendizado sobre o novo código-fonte que vamos alterar ou trocar, e esse tempo é diminuído caso o código-fonte esteja documentado.

Então faça um bem para você e para os demais, documente o seu código-fonte e vamos fazer do desenvolvimento de software um lugar mais feliz!

Aproveitante, se alguém algum dia encontrar um código-fonte tão perfeito como o citado pelo palestrante, por favor em envie, pois vou emoldurar e pendurar na parede do meu quarto.

Petter Rafael
Petter Rafael

Desenvolvedor Web atua com as tecnologias Java e PHP apoiadas pelos bancos de dados Oracle e MySQL. Além dos ambientes de desenvolvimento acima possuiu amplo conhecimento em servidores Apache/Tomcat, Photoshop, Arte & Foto, Flash e mais uma dezena de ferramentas e tecnologias emergentes. Atualmente colabora com o Viablog escrevendo sobre programação e tecnologia.

Assinar blog por e-mail

Digite seu endereço de e-mail para assinar este blog e receber notificações de novas publicações por e-mail.

Junte-se a 323 outros assinantes

Busca

setembro 2020
DSTQQSS
 12345
6789101112
13141516171819
20212223242526
27282930 

Categorias