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

BSL176 — Устаревшие методы не должны использоваться

← Все правила

Кратко

Устаревшие методы не должны использоваться

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

Поле Значение
Код правила BSL176
Совместимый псевдоним DeprecatedMethodCall
Серьёзность INFORMATION
Включено по умолчанию Да
Реализовано Да
Теги deprecated

Поведение

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

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

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

[tool.onec-hbk-bsl]
select = ["BSL176"]
ignore = ["DeprecatedMethodCall"]

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

  • noqa:
Значение = "пример";  // noqa: BSL176
  • bsl-disable (совместимый вариант):
Значение = "пример";  // bsl-disable: BSL176
  • совместимый BSLLS-вариант:
Значение = "пример";  // BSLLS:DeprecatedMethodCall-off

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

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

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

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

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

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

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

В случаях когда возникает необходимость отметить процедуру (функцию) как устаревшую, в первой строке ее описания размещается слово "Устарела." (англ. "Deprecated.").

Следует избегать использования или расширения устаревших методов. Пометка метода как устаревшего - это предупреждение о том, что метод будет удален в будущих версиях и оставлен для временной обратной совместимости.

Исключение: допустимо вызывать устаревшие методы из устаревших методов.

Помимо пользовательских методов диагностика срабатывает на вызовы платформенных методов и обращения к свойствам, помеченным устаревшими в синтакс-помощнике. Источник сведений об устаревании - синтакс-помощник установленной платформы 1С (через bsl-context) либо встроенный справочник, поэтому проверка работает и без подключенного справочника платформы. Срабатывание учитывает целевую версию платформы: член считается устаревшим, если целевая версия не ниже версии, начиная с которой член устарел. Целевая версия определяется по приоритету: настройка v8platform.targetVersion, затем режим совместимости конфигурации, а если ничего не задано - считается, что используется самая свежая платформа.

Дополнительно подсвечиваются обращения к свойствам конфигурации с префиксом Удалить/Delete - стандартная 1С-конвенция пометки устаревших реквизитов, значений перечислений и объектов конфигурации.

Для OneScript диагностика также подсвечивает обращения к устаревшим членам, помеченным во встроенном справочнике типов (механизм версионирования платформы 1С к OneScript неприменим, поэтому деpreкейт там трактуется как «устаревший всегда»).

Примеры

// Устарела. Следует использовать НеУстаревшаяПроцедура.
Процедура УстаревшаяПроцедура()
КонецПроцедуры

УстаревшаяПроцедура(); // Срабатывание диагностики

Источники