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

Имя функции начинается с глагола

Проверка позволяет контролировать использование ненужных глаголов в начале имен функций.

Например, слово "Получить" - лишнее, потому что функция по определению возвращает значение:

Функция ПолучитьМассивРолейСПравомДобавления()
Функция ПолучитьСтруктуруДополнительныхНастроек()

Правильно:

Функция ИменаРолейСПравомДобавления()
Функция ДополнительныеНастройки()

Слово "Выполнить" обычно используется для процедур и не способствует описанию возвращаемого значения в терминах предметной области:

Функция ВыполнитьПроверку(Параметр1, Рекв, ТЗ)

Правильно:

Функция РеквизитОбъектаЗаданногоТипа(Объект, ИмяРеквизита, ТипЗначения)

Вместо "Создать" и "Добавить" рекомендуется использовать слово "Новый" для описания возвращаемого значения:

Функция ДобавитьПолеФормы()
Функция СоздатьЭлементСправочникаФайлы()
Функция СоздатьПараметрыЗаполненияЦенПоставщика()

Правильно:

Функция НовоеПолеФормы()
Функция НовыйЭлементСправочникаФайлы()
Функция НовыеПараметрыЗаполненияЦенПоставщика()

Особенности:

  • Параметр Слова, с которых не должны начинаться имена Функций (через запятую) позволяет задать свой список запрещенных глаголов, указав их через запятую.
  • Значение по умолчанию: Получить,Выполнить,Создать,Добавить.

См. также

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

// sonar:FunctionNameStartsWithVerb:off
// sonar:FunctionNameStartsWithVerb:on