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

Что может быть самым сложным для программиста? Правильно, придумать имя для переменной! Что бы конфигурация была удобочитаемой, приведу некоторые стандарты, которые описывают правила именования объектов конфигурации, переменных, процедур, функций, элементов управления и т. д.

Правила составления имен переменных


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

Пример правильного имени:
  • работа с каталогом – РаботаСКаталогом;
  • количество пачек в коробке – КоличествоПачекВКоробке.
Имена переменных не следует начинать с подчеркивания. Имена переменных ни в коем случае не должны состоять из одного символа, но использование коротких имен переменных допускается только для счетчиков циклов, например: счетчик - Сч.

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

Правила составления имен процедур/функций


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

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

Имена обработчиков событий формирутся системой автоматически:
<имя элемента управления> + <название события>
Имена по-умолчанию формируются при нажатии символа лупы около события в окне свойств реквизита диалога. По таким же правилам следует образовывать имена обработчиков самостоятельно.
1. Пример правильного кода

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


Имена надписей образуются по следующим правилам:
  • если надпись относится к элементу управления, имя составляется как
    Надпись + ИмяЭлементаУправления;
  • в остальных случаях имя составляется как
    Надпись + ИмяНадписи.
Для имен рамок используется префикс Рамка. Для командной панели формы используется префикс КоманднаяПанель. Для имен командных панелей табличных частей формы используется префикс КоманднаяПанель + ИмяТабличнойЧасти, например, КоманднаяПанельСпецификация. Элементы управления, связанные с данными, называются так же, как данные.

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


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

Для реквизитов объектов допускается переставлять слова из синонима местами, например: для синонима Полное наименование, имя может быть НаименованиеПолное. Для ведущих объектов подобное не допускается.

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

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

Для форм синоним должен начинаться со слов, генерируемых конструктором при создании формы (Форма списка…, Форма элемента… и т. д.). Далее, в случае наличия нескольких форм одного назначения, обязательно должно следовать уточнение, например Форма элемента полная, Форма элемента упрощенная. Для макетов унифицированных форм синоним должен состоять из названия формы, например: ТОРГ-12.

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

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

--------------------

Комментарии