Руководство разработчика. Оформление кода в модуле собственной формы

Назад к руководству

Весь код в модуле формы группируется по определенной структуре, согласно требованиям и рекомендациям по стилю кода 1С. Общая структура модуля формы используется следующая:

#Область ОписаниеПеременных

#КонецОбласти

#Область ОбработчикиСобытийФормы
// Код процедур и функций
#КонецОбласти

#Область ОбработчикиСобытийЭлементовШапкиФормы
// Код процедур и функций
#КонецОбласти

#Область ОбработчикиСобытийЭлементовТаблицыФормы<ИмяТаблицыФормы>
// Код процедур и функций
#КонецОбласти

#Область ОбработчикиКомандФормы
// Код процедур и функций
#КонецОбласти

#Область СлужебныеПроцедурыИФункции
// Код процедур и функций
#КонецОбласти

Данные проверки также встроены в логику SonarQube - системы автоматического анализа кода.

• Раздел «Обработчики событий формы» содержит процедуры-обработчики событий формы: ПриСозданииНаСервере, ПриОткрытии и т.п.
• Раздел «Обработчики событий элементов шапки формы» содержит процедуры-обработчики элементов, расположенных в основной части формы (все, что не связано с таблицами на форме).
• В разделах «Обработчики событий элементов таблицы формы <имя таблицы формы>» размещаются процедуры-обработчики таблиц формы и элементов таблиц. Для процедур-обработчиков каждой таблицы должен быть создан свой раздел.
• Раздел «Обработчики команд формы» содержит процедуры-обработчики команд формы (имена которых задаются в свойстве Действие команд формы).
• Раздел «Служебные процедуры и функции» имеет такое же предназначение, что и в общих модулях. Здесь располагаются общие процедуры

Кроме этого, внутри раздела "Служебные процедуры и функции" рекомендуется создавать подразделы для группировки кода по следующим признакам:

• Подраздел "ОбработчикиОповещения" - для размещения клиентских экспортных процедур, вызываемых через ОписаниеОповещения.
• Подраздел "УправлениеФормой" - для размещения клиентских и серверных процедур, управляющих формой, например УправлениеФормой(Форма) для изменения свойств элементов формы, УстановкаУсловногоОформления() - для формирования правил условного оформления и т.д.
• Подраздел "ПодключаемыеКоманды" - для группировки подключаемых команд, вызываемых исключительно из программного кода.
• А также любые другие подразделы для работы.