BSL013 - Закомментированный фрагмент кода¶

Кратко¶

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

Идентификаторы¶

Поле	Значение
Код правила	`BSL013`
Совместимый псевдоним	`CommentedCode`
Серьёзность	`WARNING`
Без конфигурации	Да
BSLLS JSON, режим `ON` без переопределений	Да
Флаг реестра `implemented`	Да
Теги	`unused`

Флаг implemented отражает реестр и не подтверждает проверенное совпадение с BSLLS.

Поведение¶

Публичный идентификатор BSL013 и псевдоним CommentedCode стабильны.
Правило сообщает о случаях, описанных на этой странице.
Подавления и проектная конфигурация применяются до публикации результата.
Для выполнения правила не требуется внешний анализатор или сетевой доступ.

Настройка и подавление¶

Код BSL### - основной стабильный идентификатор. Совместимый псевдоним принимается в select, ignore и совместимых блоковых комментариях.

[tool.onec-hbk-bsl]
select = ["BSL013"]
ignore = ["CommentedCode"]

Все три семейства подавлений работают для текущей строки и диапазона. Если открывающий комментарий стоит после кода, он действует только на эту строку. Используйте любой один вариант:

noqa:

Значение = "пример";  // noqa: BSL013

bsl-disable (совместимый вариант):

Значение = "пример";  // bsl-disable: BSL013

совместимый BSLLS-вариант:

Значение = "пример";  // BSLLS:CommentedCode-off

Если тот же открывающий комментарий стоит на отдельной строке, он начинает диапазон. Закройте его парным маркером того же семейства:

// noqa: BSL013
// код без этой диагностики
// noqa-enable: BSL013

// bsl-disable: BSL013
// код без этой диагностики
// bsl-enable: BSL013

// BSLLS:CommentedCode-off
// код без этой диагностики
// BSLLS:CommentedCode-on

Чтобы отключить правило до конца файла, не добавляйте закрывающий noqa-enable, bsl-enable или BSLLS:…-on.

Открывающий и закрывающий маркеры должны принадлежать одному семейству.

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

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

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

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

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

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

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

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

Источники¶

Источник