Как трябва да се коментира структура if-else?

Ако е необходимо да коментирам if else изявления, предпочитам да опиша случая, който е накарал кода да достигне тази точка. Особено в код с висока цикломатична сложност

if (condition) { 
// User is taking a course at college x:
    i = 1;
} else { 
// User is not taking any course at college x:
    i = 2;
}

Друг вариант е:

if(condition) { //check for condition
    i = 1;
} else { //condition isn't met
    i = 2;
}

Трябва да коментирате само ако кодът не е обяснителен. Така че направете if самообяснимо. Като това може би

bool fooIsNotReallyGood = ....;

if(fooIsNotReallyGood) {
...
} else {
...
}

Ако кодът вече не е самодокументиран, тогава бих го структурирал, както следва:

if (someCondition) {
    // If some condition, then do stuff 1.
    doStuff1();
}
else {
    // Else do stuff 2.
    doStuff2();
}

Но отново, няма много смисъл, ако кодът вече се самодокументира. Ако искате да добавите коментари поради някакво сложно условие като:

if (x == null || x.startsWith("foo") || x.endsWith("bar") || x.equals("baz")) {
    doStuff1();
}
else {
    doStuff2();
}

Тогава бих обмислил да го преработя като:

boolean someCondition = (x == null || x.startsWith("foo") || x.endsWith("baz") || x.equals("waa");

if (someCondition) {
    doStuff1();
} else {
    doStuff2();
}

При което името на променливата someCondition всъщност обобщава цялото условие накратко. напр. usernameIsValid, userIsAllowedToLogin или така.

Изберете условия за самокоментиране, тогава не са необходими допълнителни коментари. Да кажем, че условието е да бъде достигната максималната стойност на заема. Това ни дава:

if (maximumLoanToValueIsReached)
{
   i=1;
}
else
{
   i=2;
}

Няма нужда да се уточнява, когато i=2, че максималният заем към стойност не е достигнат, тъй като това е очевидно. Освен това бих преименувал i на нещо по-смислено.

Коментарите са много лично нещо и (както може да се види от някои от по-ранните отговори) предизвикват толкова дебат, колкото и кодът.

В прости случаи коментарите отклоняват вниманието от кода. Но ако приемем по-сложно условие, предпочитам:

/*
** Comment explaining what the condition
** is trying to determine
*/
if ( condition )
{
    /*
    ** Comment explaining the implications
    ** of the condition being met
    */
    do_something();
}
else
{
    /*
    ** Comment explaining the implications
    ** of the condition not being met
    */
    do_something_else();
}

Във всеки случай коментарите не трябва просто да повтарят кода.

Изобщо не бих коментирал в тези конкретни случаи - коментарите не добавят никаква стойност към вашия вече ясен код. Ако имате наистина сложно условие, което е трудно за четене, бих помислил да го разложа във функция (вероятно inline) със собствено много чисто име.

//condition isn't met изглежда безполезен коментар. Но в случай, че се изисква такъв коментар, аз го правя така (C#):

//check for condition
if(condition) 
{
    i = 1;
} 
//some other condition
else 
{
    i = 2;
}

Въпреки това, ако блокът е само if-else, тогава бих обединил и двата коментара преди if.

За javascript предпочитам

//check for condition
if(condition) {
    i = 1;
} else { //some other condition
    i = 2;
}

P.S. Явно има толкова мнения, колкото и хора :)

Ето как правя моите коментари за операторите if then, въпреки че обикновено намирам, че това не е необходимо. Харесва ми да го поставя в съответствие с if/else и да го поставя на същото място

if ( condition )    //if above the bar
{
    i = 0;
    k = 1;
}
else                //else if below
{
    i = 1;
    k = 2;
}

Няма еднозначен отговор – различните хора ще имат различни мнения относно това, което е най- четиво. Мисля обаче, че има съгласие, че коментарите трябва действително да добавят стойност към (иначе разбиращия се) код и че стилът на коментиране трябва да бъде последователен.

Начинът, по който обработвам коментари за условия, които не се разбират веднага, е следният:

  // If the condition for a local tree imbalance is met,
  // juggle the immediate nodes to re-establish the balance.
  // Otherwise, execute a global balancing pass.
  if ( somewhat muddled condition )
  {
     ...code...
  }
  else // Tree is in local balance
  {
     ... more code...

  } // if/else (tree locally imbalanced) 

Коментарът за крайния '}' съществува предимно, за да придаде на края на условието повече визуална тежест, за да улесни четенето през източника.

Променливите са важни, а не самите условия.

if condition: # <condition dependent variable> was <predicated>
  dosomething()
elif othercondition: # <othercondition dependent variable> <predicated>
  dootherthing()
else: # <all variables> <not predicated>
  doelsething()

Можете да извлечете if-else код към методи и да ги наименувате правилно:

function main() {
  checkForCondition(condition);
  conditionIsNotMet(condition);
}

function checkForCondition(boolean condition) {
  if (condition) {
    i = 1;
  }
}

function conditionIsNotMet(boolean condition) {
  if (!condition) {
    i = 2;
  }
}

В такъв тривиален случай това изглежда като прекаляване, но представете си, че имате повече от един ред на клон if-else.