Допустим, у вас есть:
if(condition) {
i = 1;
} else {
i = 2;
}
и вам нужно поместить комментарии, объясняющие блоки if
и else
. Какой самый читаемый способ сделать это, чтобы кто-то мог легко забрать их на первый взгляд?
Обычно я делаю это так:
//check for condition
if(condition) {
i = 1;
} else {
//condition isn't met
i = 2;
}
который я нахожу недостаточно хорошим, поскольку комментарии находятся на разных уровнях, поэтому быстро взгляните на комментарий if
и комментарий else
будет выглядеть так, как будто он принадлежит к некоторой внутренней структуре.
Поместите их так:
if(condition) {
//check for condition
i = 1;
} else {
//condition isn't met
i = 2;
}
не выглядит хорошо для меня, так как кажется, что вся структура не комментируется (условие может быть большим и принимать несколько строк).
Что-то вроде этого:
//check for condition
if(condition) {
i = 1;
//condition isn't met
} else {
i = 2;
}
будет, вероятно, лучшим стилем с точки зрения комментариев, но запутанным как структура кода.
Как вы комментируете такие блоки?
PS. Я не спрашиваю о реорганизации этих двух строк кода, только о стиле кода и форматировании комментариев.