Материалы слушателям курсов: "Пример": 1С:Предприятие 8.2 / Разработчикам / Соглашения при написании кода

Перехват исключений в коде

Область применения: управляемое приложение, мобильное приложение, обычное приложение.Частные случаи некорректного использования и перехвата исключений

Особенности использования структур в качестве параметров процедур и функций

Область применения: управляемое приложение, мобильное приложение, обычное приложение.См. также

Описание процедур и функций

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

Работа с параметром «Отказ» в обработчиках событий

1. В обработчиках событий модулей объектов, наборов записей, форм и т.п., содержащих параметр Отказ (ПриЗаписи, ОбработкаПроверкиЗаполнения, ТоварыПередНачаломДобавления и т.п.), не следует присваивать этому параметру значение Ложь.Это требование обусловлено тем, что, как правило, в коде обработчиков событий параметр Отказ может устанавливаться сразу в нескольких последовательных проверках (или в нескольких подписках на одно и то же событие). В таком случае к моменту выполнения очередной проверки параметр Отказ уже может заранее содержать значение Истина, и можно ошибочно сбросить его обратно в Ложь.Кроме того, при доработках конфигурации на внедрении число этих проверок может увеличиться.

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

1. При объявлении формальных параметров процедур и функций (далее по тексту: функций) необходимо придерживаться общих правил образования имен переменных. В частности, имена параметров следует образовывать от терминов предметной области таким образом, чтобы из имени параметра было понятно его назначение.

Использование модуля объекта, модуля менеджера объекта и общих модулей

1. Модуль объекта предназначен для реализации поведения отдельного экземпляра объекта (СправочникОбъект, ДокументОбъект и т.п.). В модуле объекта размещаются процедуры и функции, которые работают с данными объекта (ЭтотОбъект и переменные модуля объекта), в том числе когда он еще не записан в информационную базу.

Перехват исключений в коде

В общем случае, не рекомендуется перехватывать исключение только ради выдачи сообщения об ошибке. Необработанное исключение в любом случае будет выдано пользователю в виде сообщения об ошибке.

Перенос выражений

1. При длине строки более 120 символов следует использовать переносы. Строки длиннее 120 символов делать не рекомендуется, за исключением тех случаев, когда перенос невозможен.

Использование глобальных переменных в программных модулях

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

Обработчики событий модуля формы, подключаемые из кода

Обработчикам событий модуля формы, которые устанавливаются из кода с помощью метода УстановитьДействие, рекомендуется задавать префикс Подключаемый_. Например:

Предварительная инициализация локальных переменных

В случаях когда фрагмент кода вычисляет значение одной или нескольких локальных переменных, рекомендуется явно выполнять предварительную инициализацию таких переменных. Это позволит избежать потенциальных ошибок времени выполнения, когда значение переменной оказывается Неопределено, а последующий код рассчитывает на определенный тип значения. Например:

Применение параметров отчета в СКД

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

Правила образования имен переменных

1. Имена переменных следует образовывать от терминов предметной области таким образом, чтобы из имени переменной было понятно ее назначение. 2. Имена следует образовывать путем удаления пробелов между словами. При этом, каждое слово в имени пишется с прописной буквы. Предлоги и местоимения из одной буквы также пишутся прописными буквами. Пример:См. также

Особенности применения функции ПредопределенноеЗначение

Функция глобального контекста ПредопределенноеЗначение позволяет получать значения ссылок на предопределенные элементы справочников, планов видов характеристик, планов счетов, планов видов расчета, ссылки на значения перечислений и точек маршрута бизнес-процессов по строковому имени. Например,См. также

Использование Журнала регистрации

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

Использование дублирующего кода

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

Общие требования к построению конструкций встроенного языка

1. В конструкциях встроенного языка ключевые слова пишутся канонически (как в документации или Синтакс-помощнике). Правильно:См. также