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

BSL192 — Имя функции не должно начинаться с "Получить"

← Все правила

Кратко

Имя функции не должно начинаться с "Получить"

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

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

Поведение

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

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

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

[tool.onec-hbk-bsl]
select = ["BSL192"]
ignore = ["FunctionNameStartsWithGet"]

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

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

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

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

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

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

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

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

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

В имени функции слово получить лишнее т.к. функция по определению возвращает значение.

Примеры

// Не правильно:
Функция ПолучитьИмяПоКоду()

// Правильно:
Функция ИмяПоКоду()

Источники