Onde colocar comentários em uma construção if-then-else?
Eu nunca decidi qual a melhor maneira de comentarif-then-else
construções, por isso nunca padronizei de maneira consistente para comentá-las. Agradeço qualquer insight.
Algumas opções:
uma
if (blabla) {
// this comment explains what happens in the IF case
dothis();
} else {
// this comment explains what happens in the ELSE case
dosomethingelse();
}
drawback: no caso de várias declarações dothis (), eu gostaria de comentar os principais blocos e, nesse caso, nem sempre é claro se o comentário IF pertence ao primeiro bloco dothis () ou a todo o caso IF
ou b)
if (blabla) { // this comment explains what happens in the IF case
dothis();
} else { // this comment explains what happens in the ELSE case
dosomethingelse();
}
drawback: só funciona para comentários curtos. Normalmente, comento construções IF-THEN-ELSE se o caso IF e ELSE não estiver diretamente claro no código, que normalmente requer um comentário com mais de uma linh
ou c)
// if the following happens
if (blabla) { // then do this
dothis();
} else { // or else do this
dosomethingelse();
}
PS: Eu sei sobre "o código deve ser auto-explicativo", mas nem sempre é esse o caso ...