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

Правильное выравнивание при комментировании кода
Правильное выравнивание при комментировании кода - jantined @ Unsplash

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

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();
}

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


LetsCodeIt, 27 мая 2023 г., 08:40