Я никогда не думал о том, как лучше всего комментировать конструкции IF-THEN-ELSE, поэтому я никогда не стандартизовал их, чтобы комментировать их. Я ценю любые идеи.
Некоторые параметры:
а)
IF (blabla) {
// this comment explains what happens in the IF case
dothis();
} else {
// this comment explains what happens in the ELSE case
dosomethingelse();
}
Недостаток: в случае нескольких операторов dothis() мне нравится комментировать основные блоки, и в этом случае не всегда ясно, принадлежит ли IF-комментарий к первому блоку dothis() или ко всему IF случай
или b)
IF (blabla) { // this comment explains what happens in the IF case
dothis();
} else { // this comment explains what happens in the ELSE case
dosomethingelse();
}
Недостаток : работает только для коротких комментариев. Я обычно комментирую конструкции IF-THEN-ELSE, если случай IF и ELSE не явствует прямо из кода, что обычно требует комментария больше одной строки.
или c)
// if the following happens
IF (blabla) { // then do this
dothis();
} else { // or else do this
dosomethingelse();
}
PS: Я знаю, что "код должен быть самоочевидным", но это не всегда так...