Правильное выравнивание при превышении кода

Предположим, что у меня есть код

void some_block(void)
{
    some_statement_1();
    some_statement_2();
    some_statement_3();
}

Теперь я хочу изложить комментарий № 2, но здесь я никогда не могу найти способ, которым это кажется правильным. Обычно я буду делать следующее:

void some_block(void)
{
    some_statement_1();
//    some_statement_2();
    some_statement_3();
}

Но теперь мы получили то, что выглядит как дополнительный отступ в заявлении № 2, однако можно утверждать, что отступы по-прежнему «правильные». В качестве альтернативы мы могли бы сделать:

void some_block(void)
{
    some_statement_1();
    //some_statement_2();
    some_statement_3();
}

Это выглядит немного лучше, но все же как-то не так. Однако следующее выглядит просто неуместным:

void some_block(void)
{
    some_statement_1();
  //some_statement_2();
    some_statement_3();
}

Как вы нарушаете код и сохраняете «правильный» отступ?

Обновление

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

Сейчас я столкнулся с примером, где у меня есть 5 вспомогательных функций, которые управляют 5 схожими, но немного разными структурами для меня. Я использую эти вспомогательные функции, чтобы сделать мой код более удобным для чтения.

Но на данный момент (и, возможно, на следующий месяц) одна из структур не будет использоваться. И я не могу совершить что-либо, что вызывает предупреждения компилятора, поэтому я должен нарушить эту часть кода и зафиксировать его таким образом.

Также я забыл этот последний вариант, который, я думаю, выглядит просто неправильно:

void some_block(void)
{
    some_statement_1();
//  some_statement_2();
    some_statement_3();
}
6 голосов | спросил Bjarke Freund-Hansen 1 WedEurope/Moscow2010-12-01T16:08:08+03:00Europe/Moscow12bEurope/MoscowWed, 01 Dec 2010 16:08:08 +0300 2010, 16:08:08

4 ответа


24

Отформатируйте его так, чтобы он торчал, и ваш код выглядит настолько уродливым, что вы будете вынуждены его удалить. Комментарии для комментариев, а не для обработки ненужного кода; это задача контроля версий.

ответил JeffO 1 WedEurope/Moscow2010-12-01T16:16:08+03:00Europe/Moscow12bEurope/MoscowWed, 01 Dec 2010 16:16:08 +0300 2010, 16:16:08
15

Как насчет этого?

void some_block(void)
{
    some_statement_1();
    some_statement_3();
}
ответил Paul Butcher 1 WedEurope/Moscow2010-12-01T16:32:50+03:00Europe/Moscow12bEurope/MoscowWed, 01 Dec 2010 16:32:50 +0300 2010, 16:32:50
4

Я нажимаю Ctrl- /и независимо от того, что делает моя IDE, я делаю это. Цветовое выделение говорит мне игнорировать эту строку в любом случае (или обратить внимание, в зависимости от моего контекста).

До этого я использовал замену пробелов косой чертой, сохраняя выравнивание:

block {
    codeline1;
//  codeline2;
    codeline3;
}

Очевидно, что только добавочные косые черты для кода, скрытого слева.

ответил Alex Feinman 1 WedEurope/Moscow2010-12-01T16:46:38+03:00Europe/Moscow12bEurope/MoscowWed, 01 Dec 2010 16:46:38 +0300 2010, 16:46:38
2

Как сказал Алекс в emacs, я использую область комментариев и позволяю emacs обрабатывать его. (Пожалуйста, нет голосов от пользователя vi для использования emacs. :-)). Как только я уверен в моем коде, я удаляю его. Дело в том, чтобы оставить его в своем любимом редакторе и привыкнуть к тому, что делает редактор.

ответил Manoj R 1 WedEurope/Moscow2010-12-01T17:26:45+03:00Europe/Moscow12bEurope/MoscowWed, 01 Dec 2010 17:26:45 +0300 2010, 17:26:45

Похожие вопросы

Популярные теги

security × 330linux × 316macos × 2827 × 268performance × 244command-line × 241sql-server × 235joomla-3.x × 222java × 189c++ × 186windows × 180cisco × 168bash × 158c# × 142gmail × 139arduino-uno × 139javascript × 134ssh × 133seo × 132mysql × 132