Правила программирования на Си и Си++



         

41.1. Комментарии должны иметь тот же отступ, что и окружающий текст программы


Абзацные отступы предназначены для того, чтобы сделать структуру вашей программы легко понятной. Если вы организуете отступы в комментариях беспорядочным образом, то этим вы лишите их смысла. Комментарий в следующей программе должен быть снабжен отступами:

f()

{

/* Здесь идет

 ** длинный комментарий

 */

    code();

}

Здесь имеется сходная проблема:

f()

{

int local_var;

int another_local_var;

    code();

}

Отсутствие отступа при определении локальных переменных заставляет предположить, что они находятся в той же области видимости, что имя функции (которая является глобальной). Так как это не так, то вы должны сделать отступ, чтобы указать на область видимости:

f()

{

    int local_var;

    int another_local_var;

    code();

}




Содержание  Назад  Вперед