Comentários em código fonte

Comentários em fontes é uma técnica muito utilizada, por ser muito prática e útil para o entendimento de algumas lógicas efetuadas no código do programa. 

Os principais beneficiados são:

- O analista/desenvolvedor: para entender o processo mais rapidamente, sem precisar utilizar recursos como debug, teste de mesa entre outros.

- Help desk de atendimento ao cliente/ Consultoria/ Suporte: Muitos consultores não possuem conhecimento técnico, mas conseguem abrir um código fonte, e procurando pelos comentários fica mais fácil de identificar como o processo foi desenvolvido e facilita este profissional de fazer sua análise referente à ocorrência reportada pelo cliente.

- Testador de software/ qualidade: o responsável por validar o sistema, também não precisa necessariamente ter conhecimento técnico de leitura de um código fonte, mas se em um determinado momento for necessária a abertura de um código fonte, o comentário será um facilitador para esclarecer a rotina.

Quando que um comentário é desnecessário?

- Um comentário torna-se desnecessário quando a rotina é muito simples, entre elas podemos citar as rotinas de cadastro, relatórios e consultas básicas, que envolvem poucas tabelas, que tenham uma lógica de programação clara etc. 

Por outro lado, em sistemas complexos que utilizam tecnologia nova/desconhecida por muitos, ou uma lógica complexa, com comandos como arrays, processamentos envolvendo tabelas temporárias, que possuam uma carga de dados superior, entre outros, estes podem ter comentários em alguns pontos do fonte para explicar algumas linhas (não é preciso comentar o fonte inteiro!).

Concluindo, é preciso utilizar o bom censo! Para isso devemos evitar utilizar comentários muito extensos ou desnecessários. 

Para mais informações, acesse também o link a seguir que explica sobre documentação x tempo: http://elainecristinacordeiro.blogspot.com.br/2011/10/documentar-software-x-perder-de-tempo.html

É preciso escrever comentários de forma clara e objetiva, sempre que possível referenciando a um código de chamado ou a um sistema de identificação semelhante.