Терминология для противоположности закомментирована

Question

Когда часть кода комментируется, мы просто говорим, что он «закомментирован». Но когда это не закомментировано, что это?

Без комментариев не совсем то же самое. Активный? Это определенно не прокомментировано.

Каков наилучший способ отсылки к коду?

Answer 1

Я закончил тем, что прокомментировал код код под комментарием и нормальный код код не под комментарием . Действие взять код из-под комментария или вывести из-под комментария .

Answer 2

Проблема с термином «закомментировано». Это злоупотребление функцией комментариев большинства языков. В C / C ++ вы должны использовать препроцессор для условной компиляции вашего кода, например, следующим образом:

#if 0
...
... here is the code that is not in the build
..
#endif

...
... here is the code that is in the build
...

Я вспоминаю стандарт кодирования в месте, где я раньше работал, использовал "#ifdef NOT_DEF" и несколько других символов вместо "#if 0", чтобы добавить некоторую семантику в блок "закомментированный".

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

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

Answer 3

Во время сеанса отладки я часто комментирую и раскомментирую строки кода.

С чисто семантической (и да, анально педантичной) точки зрения это действие описывается фразой, а не кодом.

«Закомментировано» - это глагол, описывающий действие, посредством которого оператор был превращен в комментарий, чтобы удалить его из кода, на который воздействовал синтаксический анализатор языка.

Код, подвергнутый противоположному действию, состоящий в том, чтобы взять комментарий и превратить его в оператор для включения его в код, на котором работает синтаксический анализатор языка, будет "Statemented In". Но, конечно, это смешно.

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

Answer 4

Я честно говорю "прокомментировал". В таких фразах, как «хорошо, это работает с закомментированной строкой, поэтому давайте прокомментируем это снова и повторно запустим тест». «Раскомментировать» было бы правильнее, но звучит неуклюже. Я бы не использовал это выражение в формальной письменности, только когда разговаривал с моей парой.

Answer 5

Видя, сколько разнородных ответов существует на этот вопрос, вы должны сделать несколько вещей.

1. Выберите термин и придерживайтесь его.

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

2. Явно опишите этот термин своим товарищам по команде.

   Не просто говорите: «это означает, что не комментируется, или как вы это называете». Не просто говорите: «Это противоположность комментариям». Скажите им, что это означает код, который был ранее закомментирован, и теперь у него удален синтаксис комментариев. Скажите им, что этот код активен и будет выполняться при вызове. Никогда не думайте, что ваша команда достаточно умна, чтобы «просто получить это» только потому, что они кивают, когда вы используете этот термин.

В качестве субъективного ответа я использую термин без комментариев . Это плохое имя для поведения, но, по крайней мере, оно слегка интуитивно понятно. Для языков, которые используют символ # для комментариев, это глупость, такая как без хэширования .

Answer 6

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