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

BSL233 — Все методы программного интерфейса должны иметь описание

← Все правила

Кратко

Все методы программного интерфейса должны иметь описание

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

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

Поведение

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

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

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

[tool.onec-hbk-bsl]
select = ["BSL233"]
ignore = ["PublicMethodsDescription"]

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

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

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

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

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

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

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

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

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

Все экспортные методы, располагающиеся в области ПрограмнныйИнтерфейс, должны иметь описание.

Источники