Codigo C - Questao de estética e praticidade

[andre_luis]

um codigo bem escrito nem precisa de comentarios!

Apesar do tom de brincadeira, não deixa de ser uma realidade.
Escrever algo estruturado e inteligível é uma verdadeira arte. Os comentários sao algumas vezes desnecessários. Mera formalidade corporativa.
Voltando ao tema, realmente os recuros dos editores por vezes mais atrapalham que ajudam...ficar o tempo todo implodindo e explodindo funções é um saco.

+++

[chipselect]

Independente de o código ser tão bem legível que é cristalino e não precise de comentário, consta da boa prática de programação colocar um mínimo de documentação com pelo menos a descrição geral da função, caso o código seja realmente útil e tenha uma chance mínima de ser reaproveitado.

Otimizações extremas de código pode obscurecer sua legibilidade e isso não significa que o código esteja mal escrito.

[xultz]

Eu acho que isso é uma lenda. Por via das dúvidas, eu entupo meus códigos de comentários para me proteger de mim mesmo.

[msamsoniuk]

eu acho que a documentacao vc tem q manter externa ao codigo... jah me aconteceu de gerar tag de codigo e aparecer codigo em arquivos html ou mesmo referencias completas dentro de comentarios (e como vou diferenciar os html puramente documentais dos html que sao compilados dentro do codigo? hehehe)... isso soh atrapalha, acho que codigo eh codigo, documentacao eh documentacao... e tem q ficar armazenado em repositorios separados!

Independente de o código ser tão bem legível que é cristalino e não precise de comentário, consta da boa prática de programação colocar um mínimo de documentação com pelo menos a descrição geral da função, caso o código seja realmente útil e tenha uma chance mínima de ser reaproveitado.

Otimizações extremas de código pode obscurecer sua legibilidade e isso não significa que o código esteja mal escrito.