Comentários

Comentários

por Alessandro Calò -
Número de respostas: 0

Oi galera,

queria dar uma dica sobre comentários. Muita gende perdeu pontos por isso nos EPs, mas é mais fácil do que parece sorriso

Basicamente, o comentário precisa ser feito para:

1) Explicar como usar o código, para modificá-lo (ou corrigí-lo) facilmente.
2) Explicar porque algumas decisões foram tomadas, especialmente em partes complicadas.

Por exemplo: suponha que vc tenha uma função " double seno (double x, double epsilon)". O comentário da função deveria ser:

/* Funcao que calcula e retorna o seno do valor x usando a série de Taylor, considerando somente termos maiores que o valor epsilon */
em vez de:
/* calcula seno de x */

---------------------------------------------------------------------------------

Dentro dessa função, suponha que exista um "if(i%2!=0)". Você deve comentar:

/* Na série, só deve-se considerar os termos ímpares, então ignora-se os termos pares  */
em vez de:
/* se o resto da divisão de i por 2 for diferente de zero */

Ou seja, eu entendo o que "i%2!=0" quer dizer, mas não sei porque você está fazendo isso

-----------------------------------------------------------------------------------
outro exemplo:

logo antes de um "x_backup = x", comente
/* Aqui, o valor de x é salvo na variável x_backup para ser usado depois para blablabla */
em vez de:
/* inicialização da variável x_backup */


Enfim, o resumo é: não precisa fazer comentários óbvios. Não precisa comentar todas as linhas. Precisa fazer comentários nas partes complicadas, nas partes "incomuns" do seu EP, explicando porque está fazendo aquilo. Também precisa comentar cada função, explicando o que ela recebe e o que ela retorna. Possivelmente, dentro da função, se for complicada, explicar como ela faz os seus cálculos.


Bom, é isso, boa sorte com o EP3! As notas do EP2 já estão saindo!