Comentários sobre: Comentários no código. Até aonde ir? http://www.brasiltech.net/agilez/2009/08/15/como-comentar-seu-codigo-fonte-de-forma-eficaz/ Metodologias e técnicas aplicadas a desenvolvimento e gerenciamento Fri, 29 Jul 2011 18:30:05 +0000 hourly 1 http://wordpress.org/?v= Por: Douglas Cunha http://www.brasiltech.net/agilez/2009/08/15/como-comentar-seu-codigo-fonte-de-forma-eficaz/comment-page-1/#comment-9 Douglas Cunha Tue, 18 Aug 2009 14:24:08 +0000 http://www.brasiltech.net/agilez/2009/08/15/como-comentar-seu-codigo-fonte-de-forma-eficaz/#comment-9 <a href="#comment-8" rel="nofollow">@Leila </a> É verdade Leila. Vou pensar nisso em uma próxima abordagem deste assunto, talvez quando falar sobre usabilidade aplicada ao código. @Leila
É verdade Leila. Vou pensar nisso em uma próxima abordagem deste assunto, talvez quando falar sobre usabilidade aplicada ao código.

]]> Por: Leila http://www.brasiltech.net/agilez/2009/08/15/como-comentar-seu-codigo-fonte-de-forma-eficaz/comment-page-1/#comment-8 Leila Tue, 18 Aug 2009 14:03:12 +0000 http://www.brasiltech.net/agilez/2009/08/15/como-comentar-seu-codigo-fonte-de-forma-eficaz/#comment-8 Depois de ler seu artigo, concordo com você. Nomes longos de variáveis, métodos e classes servem como comentários. Outro ponto importante, uma vez levantado por um colega meu, são as linhas em branco. Linhas em branco podem servir para agrupar código correlato dentro de um método, da mesma forma que parágrafos dividem um texto. Depois de ler seu artigo, concordo com você. Nomes longos de variáveis, métodos e classes servem como comentários. Outro ponto importante, uma vez levantado por um colega meu, são as linhas em branco. Linhas em branco podem servir para agrupar código correlato dentro de um método, da mesma forma que parágrafos dividem um texto.

]]> Por: Pitty http://www.brasiltech.net/agilez/2009/08/15/como-comentar-seu-codigo-fonte-de-forma-eficaz/comment-page-1/#comment-7 Pitty Mon, 17 Aug 2009 12:22:25 +0000 http://www.brasiltech.net/agilez/2009/08/15/como-comentar-seu-codigo-fonte-de-forma-eficaz/#comment-7 Boa Douglas! Outra questão importante é a atualização dos comentários. Com a adoção de práticas de refatoração, conseguimos melhorar continuamente nosso código, mas quase sempre nos esquecemos de atualizar os comentários que descrevem a responsabilidade de uma classe ou a motivação por trás da utilização de um algoritmo. Por isso um código bem escrito e claro é melhor, mesmo que nossas rotinas fiquem com nomes extensos, como ColecaoDeVendas.RatearValorEntreAsVendas(valorASerRateado: currency). Boa Douglas!

Outra questão importante é a atualização dos comentários. Com a adoção de práticas de refatoração, conseguimos melhorar continuamente nosso código, mas quase sempre nos esquecemos de atualizar os comentários que descrevem a responsabilidade de uma classe ou a motivação por trás da utilização de um algoritmo.

Por isso um código bem escrito e claro é melhor, mesmo que nossas rotinas fiquem com nomes extensos, como ColecaoDeVendas.RatearValorEntreAsVendas(valorASerRateado: currency).

]]>