#std647

Имена процедур и функций

1.

Чем лучше имена - тем проще читать код. Хорошо выбранное имя процедуры и имена параметров описывают её смысл лучше, чем комментарии. Если имя подобрать сложно - возможно, уже есть проблема в архитектуре решения. Если самодокументирующееся имя придумать легко - все спроектировано верно.

См. Описание процедур и функций #std453

2.

Имена процедур, функций и параметров берите от терминов предметной области. Из имени должно быть понятно назначение. Старайтесь выбирать говорящие (самодокументирующиеся) имена.

См. Параметры процедур и функций #std640

Неправильно

Функция ВыполнитьПроверку(Параметр1, Рекв, ТЗ)
Функция ПолучитьМассивыРеквизитов(ХозяйственнаяОперация, МассивВсехРеквизитов, МассивРеквизитовОперации)

Правильно

Функция РеквизитОбъектаЗаданногоТипа(Объект, ИмяРеквизита, ТипЗначения)
Функция ЗаполнитьИменаРеквизитовПоХозяйственнойОперации(ХозяйственнаяОперация, ИменаВсеРеквизиты, ИменаРеквизитыОперации)

3.

Формируйте имена так:

• Удалите пробелы между словами.
• Каждое новое слово напишите с большой буквы.
• Предлоги и местоимения пишите большими буквами.

4.

Не используйте типы в названиях процедур и функций. Использовать можно только если без использования неясно название метода.

Неправильно

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

Правильно

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

5.

Имена процедур берите от неопределенной формы глагола. От сути выполняемого действия.

Неправильно

Процедура ЗагрузкаКонтрагента()

Правильно

Процедура ЗагрузитьКонтрагента()

6.1.

Имена функций берите от описания возвращаемого значения.

Неправильно

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

Правильно

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

6.2.

Если функция создает какой-то объект, назовите его со слова Новый.

Неправильно

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

Правильно

Функция НовоеПолеФормы() 
Функция НовыйЭлементСправочникаФайлы()
Функция НоваяТаблицаКоманд()

6.3.

Если функция выполняет проверку, назовите ее со слова Это или используйте причастие.

Неправильно

Функция ПроверитьПроведенностьДокумента()
Функция ПроверитьИзменениеРеквизитовДокумента()
Функция ВнешняяЗадача()

Правильно

Функция ДокументПроведен()
Функция РеквизитыДокументыИзменены()
Функция ЭтоВнешняяЗадача()

6.4.

Если для понимания назначения функции важно каким образом было получено возвращаемое значение, назовите ее от глагола в неопределенной форме.

Правильно

Функция ВыбратьДанныеПоПравилу(Правило, ПользовательскиеНастройки)
Функция ПреобразоватьДанныеПоПравилу(НаборыДанных, ПараметрыПреобразования)

6.5.

Если функция используется как процедура, ее действие - основная задача, ее результат - побочный эффект, называйте функции как процедуры. Используйте глагол неопределенной формы. Например, возвращает признак выполненного действия.

Правильно

Функция РазрешитьРедактированиеРеквизитовОбъекта(Форма) 

Источник

https://its.1c.ru/db/v8std#content:647