CommentedCode.md

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

Тип	Поддерживаются языки	Важность	Включена по умолчанию	Время на исправление (мин)	Теги
Дефект кода	BSL OS	Незначительный	Да	1	standard badpractice

Параметры

Имя	Тип	Описание	Значение по умолчанию
threshold	Число с плавающей точкой	Порог чуствительности	0.9

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

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

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

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

также неправильно:

Процедура ПередУдалением(Отказ)
    Если Истина Тогда
        // Иванов: доделать 
    КонецЕсли;
КонецПроцедуры

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

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

Источники

• Источник

Сниппеты

Экранирование кода

// BSLLS:CommentedCode-off
// BSLLS:CommentedCode-on

Параметр конфигурационного файла

"CommentedCode": {
    "threshold": 0.9
}