Перейти к содержанию
bslls:CommentedCode

Закомментированный фрагмент кода (CommentedCode)

  • Тип: Дефект кода
  • Важность: Незначительный
  • Включена по умолчанию: Да
  • Теги: standard, badpractice

Описание диагностики

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

Например, недопустимо оставлять подобные фрагменты в коде после завершения отладки или рефакторинга:

Процедура ПередУдалением(Отказ)
//    Если Истина Тогда
//        Сообщение("Для отладки");
//    КонецЕсли;
КонецПроцедуры
также неправильно: 
Процедура ПередУдалением(Отказ)
    Если Истина Тогда
        // Иванов: доделать
    КонецЕсли;
КонецПроцедуры

Правильно: после завершения отладки или рефакторинга удалить обработчик ПередУдалением из кода.

ВНИМАНИЕ: Блок комментарием считается кодом, если хотя бы одна строка внутри блока определяется как код.

Источники

Соответствие стандартам

  • #std456, п. 3: Тексты модулей — Диагностика «Закомментированный фрагмент кода (CommentedCode)» проверяет условие пункта 3 стандарта std456.

Источник диагностики