Комментарии в конце строки

Блочные

Очень короткие комментарии могут стоять на одной строке с комментируемым кодом, но должны быть отделены от него отступом. Если таких комментариев в фрагменте кода больше одного, они должны быть выровнены по одному уровню. Избегайте комментирования, как в ассемблере, в конце каждой строки исполняемого кода.

Вот пример кода с блочным комментарием в конце строки:

if (a == 2) {
    return TRUE;            /* особый случай */
} else {
    return isPrime(a);      /* только для нечетной a */
}

Однострочные

"//" - знак означающий начало однострочного комментария в плоть до конца строки. Он может занимать всю строку или только ее часть. Не стоит использовать однострочный комментарий для многострочного текста; однако, так можно закомментировать часть кода. Пример всех трех стилей:

if (foo > 1) {

    // Делаем двойной переворот
    ...
}
else {
    return false;          // Пояснение, почему так
}
//if (bar > 1) {
//
//    // Делаем тройной переворот
//    ...
//}
//else {
//    return false;
//}

Last updated