Другое · 7 мин
Как объявить функцию в 1С: пошаговое руководство
Как объявить функцию в 1С: синтаксис объявления, параметры, возврат значения, контекст клиент-сервер, проверка синтаксиса и типичные ошибки в конфигурации.
В 1С:Предприятии функция — это именованный фрагмент кода, который принимает параметры и обязательно возвращает результат. В отличие от процедуры, функция не просто выполняет действия, а передаёт вычисляемое значение обратно в точку вызова, откуда её вызвали.
Объявляют функцию в модуле конфигурации: общем модуле, модуле объекта, модуле формы или другом модуле, где разрешено описание процедур и функций. Область видимости зависит от размещения: функция может быть доступна только внутри своего модуля или экспортирована для использования в других частях конфигурации.
Перед тем как писать код, определите, на каком уровне будет работать функция: на клиенте, на сервере или в обоих контекстах. От этого зависит набор доступных объектов, способ вызова и необходимость в директивах контекста выполнения.
Синтаксис объявления функции
Общий вид объявления функции выглядит так:
Функция <Имя>(<Параметры>) <Экспорт>
// тело функции
Возврат <Выражение>;
КонецФункции
Ключевое слово Функция начинает описание, за ним следует имя функции и список параметров в скобках. Модификатор Экспорт делает функцию доступной за пределами модуля, в котором она объявлена. Без этого слова функция видна только внутри своего модуля.
Оператор Возврат обязателен: он задаёт значение, которое функция вернёт при вызове. Если в теле функции несколько веток, какая-либо из них должна выполнить Возврат на всех возможных траекториях выполнения, иначе при вызове может вернуться неопределённое значение.
- 1Определите имя функции и список параметров
- 2Выберите модуль для размещения: общий, объектный или модуль формы
- 3Добавьте модификатор Экспорт, если функция нужна в других модулях
- 4Напишите тело функции и завершите его оператором Возврат
- 5Завершите описание словом КонецФункции
- 6Выполните проверку синтаксиса конфигурации
Параметры и возвращаемое значение
Параметры перечисляются внутри скобок через запятую. Для каждого параметра можно указать тип, но это не обязательно: 1С позволяет объявлять параметры без явного указания типа. При вызове функция получает значения параметров в том порядке, в котором они перечислены при объявлении.
Тип возвращаемого значения в заголовке функции не объявляется. Результат определяется выражением после оператора Возврат. Если нужно вернуть несколько связанных значений, удобно вернуть структуру, таблицу значений или другой составной объект, а не пытаться вернуть несколько значений через параметры.
Когда функция не подходит — процедура
Если задача заключается только в выполнении действий без возврата результата — например, записи в регистр, открытии формы или заполнении таблицы — целесообразнее объявить процедуру через ключевое слово Процедура. Процедура не содержит оператора Возврат и не возвращает значение вызывающему коду.
Контекст выполнения: клиент и сервер
Функция может работать на клиенте, на сервере или в обоих контекстах. Для указания контекста используются директивы &НаКлиенте и &НаСервере, размещаемые перед объявлением функции. Функция, помеченная серверной директивой, не может быть вызвана напрямую из клиентского кода без специального механизма вызова на сервер.
Выбор контекста определяет, какие объекты доступны внутри функции. Серверный код работает с данными и объектами конфигурации на стороне сервера, клиентский — с интерфейсом и сеансом пользователя. Неправильный выбор контекста приводит к ошибкам при выполнении или недоступности нужных объектов.
Если функция вызывается из разных мест конфигурации, убедитесь, что контекст вызова совместим с контекстом объявления. В противном случае потребуется пересмотреть место размещения функции или разделить логику на клиентскую и серверную части.
Где объявлять функции в конфигурации
Общий модуль подходит для функций, которые нужны в разных частях конфигурации. Если модуль помечен как общий и функции в нем имеют модификатор Экспорт, они становятся доступны из других модулей конфигурации.
Модуль объекта используется для функций, связанных с конкретным справочником, документом или другим объектом метаданных. Такие функции имеют прямой доступ к реквизитам объекта, в модуле которого они объявлены.
Модуль формы содержит функции, относящиеся к интерфейсной форме: обработка событий элементов, работа с данными формы и управление открытыми окнами. Функции из модуля формы не подходят для общих бизнес-правил, которые нужны вне формы.
Проверка синтаксиса и типичные ошибки
После написания кода обязательно выполните проверку синтаксиса конфигурации. Конфигуратор указывает отсутствие КонецФункции, несоответствие количества параметров при вызове, отсутствие Возврат и другие грамматические ошибки.
Частые ошибки: забытое ключевое слово КонецФункции, вызов функции с неверным количеством аргументов, использование функции без Экспорт из другого модуля, попытка вызвать серверную функцию из клиентского кода без механизма серверного вызова, а также совпадение имен функций в разных модулях, что затрудняет отладку.
Как проверить результат
Ошибок синтаксиса нет
Конфигуратор указывает на отсутствие КонецФункции или Возврат
Функция выполняется и возвращает ожидаемое значение
Ошибка доступа или несоответствие контекста клиент-сервер
Результат корректно меняется в зависимости от входных данных
Результат не меняется или возвращает одно и то же значение
Безопасные границы самостоятельной работы
Объявление собственных функций в пользовательских модулях и общих модулях, созданных вами, относится к безопасным действиям. Риск возрастает при правке стандартных объектов конфигурации, особенно если база используется в торговле, бухгалтерии или других критичных участках учета.
Перед внесением изменений создайте резервную копию информационной базы или работайте в изолированной среде разработки. После добавления функции проверьте её в нескольких сценариях: с обычными значениями, с пустыми параметрами и при повторных вызовах.
Что важно запомнить
Функция в 1С объявляется через Функция и КонецФункции, возвращает значение через Возврат, может быть экспортирована и привязана к клиентскому или серверному контексту.
Часто задаваемые вопросы
Нужно ли указывать тип возвращаемого значения в заголовке функции?
Нет, в 1С тип возвращаемого значения не объявляется в заголовке функции. Он определяется выражением, которое передаётся после оператора Возврат в теле функции.
Может ли функция не возвращать значение?
Нет, по определению функция должна возвращать результат. Если вам нужно только выполнить действия без возврата значения, используйте процедуру, объявленную через слово Процедура.
Где лучше разместить функцию, которая нужна в нескольких документах?
Лучше разместить такую функцию в общем модуле с модификатором Экспорт. Тогда она будет доступна из модулей различных документов и других объектов конфигурации.
Что делать, если функция работает на клиенте, но нужна на сервере?
Нужно либо перенести объявление в серверный контекст с директивой &НаСервере, либо организовать вызов серверной функции из клиентского кода через соответствующий механизм вызова на сервер, в зависимости от архитектуры конфигурации.
Как проверить, что функция объявлена правильно?
Выполните проверку синтаксиса конфигурации, затем вызовите функцию из целевого места с разными наборами параметров и убедитесь, что возвращаемое значение соответствует ожидаемому.