2.3. Стандарты именования переменных, процедур и объектов конфигурации

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

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

Имена переменных (параметров) следует образовывать от терминов предметной области. При именовании переменных следует использовать только термины, используемые в документации к 1С:предприятию 8.0 или в методических материалах фирмы «1С».

Из имени переменной должно быть понятно ее назначение.

Имена следует образовывать путем «склеивания» слов – удаления пробелов между словами. Каждое отдельное слово в «склеенном» имени пишется с прописной буквы. Предлоги и местоимения из одной буквы также пишутся прописными буквами.

Например:

Работа с каталогом – РаботаСКаталогом

Количество пачек в коробке – КоличествоПачекВКоробке

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

Именование переменных-флагов

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

Например, если нужна переменная, в которой хранится признак наличия ошибок в процедуре, то такая переменная должна называться «ЕстьОшибки». Или если есть признак того, что товар относится к возвратной таре, то такой признак должен называться «ЭтоТара».

Правила образования имен процедур (функций)

Имена процедур в общем случае, следует образовывать от глаголов неопределенного вида, например:

Правильно: ПроверитьДублиСтрок(),

Неправильно: ПроверкаДублейСтрок();

Правильно: ЗагрузитьКонтрагента(),

Неправильно: ЗагрузкаКонтрагента().

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

Примеры хороших имен:

ПодобратьВидРасчета(), ПолучитьИнформациюОПроводке() и т.д.

Примеры плохих имен: ОК(), Есть(), ЕщеФлажки(), НамПодходит() и т.д.

Именование функций-флагов

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

Например, если функция должна проверить наличие дублей строк в табличной части документа, то она должна называться «ЕстьДублиСтрок». Или если функция должна проверить принадлежность документа к накладным, то она должна называться «ЭтоНакладная».

Однако, если функция (или процедура) «ЕстьДублиСтрок» и проверяет наличие дублей строк, и выполняет объединение дублирующих строк, при этом не возвращает значения, ее следует именовать «СвернутьДублиСтрок».

Имена обработчиков событий

Используются имена процедур – обработчиков событий, формируемые системой автоматически:

<имя элемента управления> + <название события>

Имена по умолчанию формируются при нажатии «лупы» около события в окне свойств реквизита диалога.

По таким же правилам следует образовывать имена обработчиков самостоятельно.

Правила образования имен элементов управления

Имена надписей образуются по следующим правилам:

• Если надпись относится к элементу управления, имя составляется как «Надпись» + ИмяЭлементаУправления;

• В остальных случаях имя составляется как «Надпись» + ИмяНадписи.

Для имен рамок используется префикс «Рамка».

Для командной панели формы используется префикс «КоманднаяПанель».

Для имен командных панелей табличных частей формы используется префикс «КоманднаяПанель» + ИмяТабличнойЧасти, например, «КоманднаяПанельСпецификация».

Элементы управления, связанные с данными, называются так же, как данные.

Общие требования к имени объекта конфигурации

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

Для реквизитов объектов допускается переставлять слова из синонима местами, например: синоним «Полное наименование» - имя «НаименованиеПолное».

Для ведущих объектов подобное не допускается.

Общие требования к синониму объекта конфигурации

Синоним объекта должен быть определен так, чтобы осмысленно описывать объект. Сокращения допускаются только общепринятые, например, «ОКЕИ», «ИНН». Следует избегать излишне длинных синонимов, но и укорачивать их с потерей смысла тоже плохо. Синоним начинается с большой буквы, точки ставятся только после сокращений.

Для ведущих объектов метаданных необходимо стремиться к тому, чтобы название объекта в меню, подпись в диалоговых формах совпадали с синонимом или, как минимум, начинались с него.

Для реквизитов объектов подписи в диалогах могут отличаться «в силу обстоятельств» - синоним надо подбирать так, чтобы он осмысленно описывал реквизит в возможных универсальных формах.

Для форм синоним должен начинаться со слов, генерируемых конструктором при создании формы («Форма списка…», «Форма элемента…» и т.д.), далее, в случае наличия нескольких форм одного назначения, обязательно должно следовать уточнение, например, «Форма элемента полная», «Форма элемента упрощенная».

Для макетов унифицированных форм синоним должен состоять из названия формы, например: «ТОРГ-12».

Общие требования к комментарию объекта конфигурации

Комментарий задается только в тех случаях, когда необходимы какие-либо пояснения. Комментарий начинается с большой буквы, точки ставятся только после сокращений. Если в синониме использовано сокращение, в комментарии необходимо его расшифровать, например: «Общероссийский классификатор единиц измерения».

Для реквизитов объектов в комментариях в необходимых случаях должно содержаться уточнение, например: «Сумма со всеми налогами».