Quando se escreve um código há muita informação valiosa apenas na própria cabeça e essa informação é perdida. Tudo o que um futuro leitor tem é o código e os respectivos comentários.

Então o comentário é a ferramenta para registar os conhecimentos que ficariam apenas na cabeça e são importantes para a compreensão do código.

 

Ideia chave:  o comentário serve para ajudar o leitor a saber tanto quanto o autor do código no momento de sua criação.

 

Exemplo:

// Código da tarefa "Aprovar". Definido no fluxo do processo no ECM

#DEFINE NTASKAPR 3

  • Sem rótulos