Опасность использования вложенных комментариев для быстрой (де) активации блоков кода в C ++

Question

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

//* First Case, Activated
DoSomething();
/**/

/* Second Case, De-Activated
DoSomethingElse();
/**/

Я могу активировать, деактивировать блоки кода, просто добавивили удаление '/'.

Компилятор предупреждает меня об этом, поскольку вложенные комментарии плохие , но на самом деле опасно ли использовать эти комментарии?

Answer 1

Вот как люди обычно делают это:

#if 0
//...
#endif

или

#define TESTWITH

#ifdef TESTWITH
//..
#endif

Answer 2

Вот как вы можете попасть в беду:

//* First Case, Activated
DoSomething();
/**/

/* Second Case, De-Activated
/* Comment about DoSomethingElse */
DoSomethingElse();
/**/

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

Конечно, этого можно избежать, никогда не используя комментарии в стиле /**/, и это зависит от вашей среды, если это разумно. А редактор с подсветкой синтаксиса (даже включая редактор ответов Stack Overflow) подскажет вам, что происходит. Но зачем вводить такую ​​возможность?

Это также относится к категории "симпатичных". Вы смешиваете два разных синтаксиса комментирования. Пока все понимают, что происходит и играют по правилам, у вас все будет хорошо. Но как только кто-то не попадает в беду.

Answer 3

Почему вы чувствуете необходимость так часто включать и выключать блоки кода?Скорее всего, вы делаете что-то не так на более высоком уровне.

Возможно, вам следует использовать контроль исходного кода и просто создать две (или более) ветви для тестирования различных версий вашего кода.

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

Answer 4

Не прямой ответ, но вы рассматривали вместо этого #ifdef?

#define DOSOMETHING

#ifdef DOSOMETHING
DoSomething();
#else
DoSomethingElse();
#endif

Answer 5

Да, вы часто заканчиваете комментированием или комментированием, и получаете код, отличный от ожидаемого, и это делает отладку очень запутанной. Использование // гораздо надежнее для этого - вам придется печатать больше, но это более предсказуемо.