#std550

Имена объектов метаданных в конфигурациях

Стандарт дополняет общие правила именования: #std474: Имя, синоним, комментарий.

1.

Подсистемы именуйте по общим правилам наименования метаданных.

Примеры

Финансы, Маркетинг, НастройкаИАдминистирование.

См. также: #std543: Использование подсистем.

2.

Для именования общих модулей используйте #std469: Правила создания общих модулей.

3.

Параметры сеанса именуйте по общим правилам наименования метаданных.

Примеры

ТекущийПользователь, ОбменДаннымиВключен, РаботаСВнешнимиРесурсамиЗаблокирована.

См. также: #std413: Использование параметров сеанса.

4.

Для ролей используйте одну из двух схем:

• прикладные роли именуйте по должности: Бухгалтер, Кассир, Администратор;
• технические роли (для точной настройки прав) именуйте по разрешаемому действию: ДобавлениеИзменениеНСИ, ЧтениеДополнительныхСведений.

См. также: #std488: Стандартные роли.

5.

Общие реквизиты именуйте по общим правилам наименования метаданных.

6.

Для планов обмена используйте такие правила:

• для РИБ (Распределенная ИБ = Истина) имя должно кратко описывать правило синхронизации: Полный, ПоОрганизациям, ПоСкладамИОрганизациям;
• для обмена между конфигурациями имя формируйте из источника и приемника, и в обеих базах имя должно быть одинаковым: ОбменУправлениеНебольшойФирмойБухгалтерияПредприятия;
• если обмен выполняется между разными редакциями, добавляйте номера редакций: ОбменУправлениеТорговлей110РозничнаяТорговля10.

7.

Критерии отбора именуйте во множественном числе, по списку отбираемых объектов.

Примеры

СвязанныеДокументы, ФайлыВТоме.

8.

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

Неправильно

ЗапретРедактированияРеквизитовОбъектовПередЗаписьюОбъекта НастройкаПорядкаЭлементовПередЗаписью

Правильно

ПроверитьИзменениеРеквизитовОбъекта ПересчитатьПорядковыйНомерЭлемента

9.

Регламентные задания именуйте в единственном числе, от существительного.

Неправильно

УстановитьПериодРасчитанныхИтогов УведомитьИсполнителейОНовыхЗадачах

Правильно

УстановкаПериодаРасчитанныхИтогов УведомлениеИсполнителейОНовыхЗадачах

10.

Функциональные опции, связанные с константами, именуйте по включаемой или выключаемой функциональности.

Примеры

Для типа Булево: ИспользоватьБизнесПроцессыИЗадачи, ИспользоватьВерсионированиеОбъектов.

Для других типов: ПрефиксИнформационнойБазы, ВариантыВерсионированияОбъектов.

См. также: #std470: Использование функциональных опций.

11.

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

Примеры

Организация (связан со справочником Организации).

ТипОбъектаКонфигурации (связан, например, с РегистрСведений.НазначениеДополнительныхОбработок.Измерение.ТипОбъекта и РегистрСведений.НастройкаВерсионированияОбъектов.Измерение.ТипОбъекта).

См. также: #std470: Использование функциональных опций.

12.

Определяемые типы именуйте в единственном числе, по назначению.

Не используйте:

• названия стандартных типов (Строка, Число);
• технические слова, не влияющие на смысл (Тип..., Объект..., Ссылка...).

Неправильно

Строка25 СсылкиНаКонтактыВзаимодействий

Правильно

АртикулНоменклатуры КонтактВзаимодействий

См. также: Использование определяемых типов.

13.

Хранилища настроек именуйте по общим правилам наименования метаданных.

Пример

ХранилищеВариантовОтчетов.

14.

Общие формы именуйте от существительных. Не используйте в имени слова, удаление которых не меняет смысл (Форма..., Окно..., Диалог...).

Примеры

НастройкаСистемы, МоиНастройки, ПараметрыПроксиСервера, ВыборОбъектовМетаданных.

15.

Для общих команд используйте такие правила:

• если команда размещается в панели навигации формы или раздела, имя должно описывать открываемый список: ДополнительныеОтчетыИОбработкиЗаполнениеОбъекта, ЗадачиПоБизнесПроцессу;
• в остальных случаях имя обычно задают от неопределенной формы глагола: ВыполнитьСопоставление, УстановитьРасширениеРаботыСФайлами.

16.

Группы команд именуйте от существительных.

Примеры

ПараметрыОбменаДанными, Печать.

17.

Интерфейсы именуйте по общим правилам наименования метаданных. Правило относится к обычному приложению.

См. также:

• Общие правила построения интерфейсов,
• Общие интерфейсы.

18.

Общие макеты именуйте от существительных, которые кратко описывают назначение или содержимое. Не используйте слова, удаление которых не меняет смысл (Макет...).

Примеры

ДополнительнаяОбработка, КомпонентаTWAIN, ОписаниеИзмененийСистемы.

19.

Общие картинки именуйте по общим правилам наименования метаданных.

Дополнительно:

• можно указывать размер в имени: УправлениеПоиском32, ДлительнаяОперация48;
• для картинок-коллекций добавляйте префикс Коллекция: КоллекцияВариантыВажностиЗадачи;
• не используйте лишние слова: Картинка..., Изображение..., Пиктограмма....

Примеры

Найти, ЗакрепитьВариантОтчета, Папка.

20.

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

Пример

Файлы.

21.

Web-сервисы именуйте на английском языке, от существительных. Не используйте кириллицу и лишние слова (Service, WebService).

Операции и параметры Web-сервисов также именуйте на английском языке.

Примеры

Files, Accounts, FlightStatus, GetCurrencyRate.

22.

WS-ссылки именуйте от существительных по назначению сервиса. Не используйте лишние слова (WebСервис..., Сервис..., Ссылка...).

Примеры

ДанныеОтгрузки, КонверторВалют.

23.

Элементы стиля именуйте от существительных по назначению.

В имени допустимо уточнение параметра стиля.

Примеры

ВыполненнаяЗадача, ПоясняющийТекст, НеСтартованныйБизнесПроцесс, УдаленныйДополнительныйРеквизитЦвет, УдаленныйДополнительныйРеквизитШрифт.

См. также:

• Элементы стиля,
• #std524: Стили.

24.

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

См. также: #std524: Стили.

25.

Языки именуйте по наименованию языка интерфейса.

Примеры

Русский, Английский.

26.

Константы именуйте по таким правилам:

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

Примеры

ТипХраненияФайлов, НастройкаПроксиСервера, ВыполнятьПроверкуЭЦПНаСервере, ИзменятьЗаданияЗаднимЧислом.

Не используйте лишние слова (Константа...).

27.

Справочники именуйте во множественном числе, по списку хранимых объектов.

Примеры

Валюты, ГруппыИсполнителейЗадач, ПрофилиГруппДоступа, Пользователи.

Не используйте лишние слова (Справочник...).

28.

Документы именуйте в единственном числе.

Примеры

ЗаказПокупателя, ПеремещениеТоваров, Анкета.

Не используйте лишние слова (Документ...).

28.1.

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

Пример

Для процесса сверки взаиморасчетов: СверкаВзаиморасчетов.

28.2.

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

Пример

ТоварноТранспортнаяНакладная.

29.

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

Примеры

СкладскиеДокументы, КорректировкиНДС.

Не используйте лишние слова (Документы...).

30.

Перечисления именуйте во множественном числе.

Неправильно

ДействиеСДокументамиПоДвойномуЩелчку ВажностьЗадачи SMTPАутентификация

Правильно

ДействияСДокументамиПоДвойномуЩелчку ВариантыВажностиЗадачи ВидыSMTPАутентификации

Исключения допустимы, но должны быть обоснованы.

Пример

ПолФизическогоЛица.

31.

Для отчетов и вариантов отчетов применяйте отдельные правила.

31.1.

Имена отчетов и вариантов отчетов образуйте от существительного.

Примеры

ДинамикаИзмененийФайлов, СписокЗависшихЗадач, СправкаОбИсполнительскойДисциплине.

31.2.

Если отчет или вариант отчета предназначен для печати, предусмотрите вывод заголовка.

Методическая рекомендация

Для отчетов с макетом заголовок размещайте в макете.

Для вариантов отчетов без макета используйте свойство Заголовок на закладке Дополнительные настройки.

31.3.

Представление варианта отчета:

• должно лаконично и однозначно описывать данные варианта;
• должно совпадать с заголовком печатной формы, если заголовок выводится;
• не должно быть образовано как имя отчета + уточнение в скобках или через разделители.

Неправильно

Для отчета Валовая прибыль: Основной, По заказам.

Правильно

Для отчета Валовая прибыль: Валовая прибыль по контрагентам, Валовая прибыль по заказам.

31.4.

Не используйте в именах отчетов и вариантов отчетов лишние слова (Отчет...).

32.

Обработки именуйте от существительного.

Примеры

КонтрольЖурналаРегистрации, РегламентныеИФоновыеЗадания, УправлениеИтогамиИАгрегатами.

Не используйте лишние слова (Обработка...).

Если обработка открывается из панели навигации формы или раздела, ее имя должно совпадать с именем команды открытия.

33.

Планы видов характеристик именуйте во множественном числе, по списку объектов, которые они описывают.

Примеры

ВидыДоступа, ВопросыДляАнкетирования, ДополнительныеРеквизитыИСведения.

34.

Планы счетов именуйте в единственном числе, от существительного по назначению. Не используйте лишние слова (ПланСчетов...).

При этом в синониме можно использовать полное наименование.

Примеры (имя - синоним)

• ЕПСБУ - ЕПСБУ
• БухгалтерскийУчет - План счетов бухгалтерского учета
• УправленческийУчет - План счетов управленческого учета
• МеждународныйУчет - План счетов международного учета

Для уточнений используйте свойство Пояснение.

Примеры с пояснением

НалоговыйУчет: План счетов налогового учета

Пояснение: План счетов налогового учета (по налогу на прибыль)

ЕПСБУ: ЕПСБУ

Пояснение: Единый план счетов бюджетного учета

35.

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

Примеры

ОсновныеНачисления, УправленческиеНачисления, Удержания.

36.

Регистры сведений и регистры накопления именуйте во множественном числе, по списку записей, которые в них хранятся.

Примеры

ДокументыФизическихЛиц, ФайлыВРабочемКаталоге, ДвиженияДенежныхСредств.

37.

Регистры бухгалтерии и регистры расчета именуйте по списку записей, которые в них хранятся.

Примеры

Хозрасчетный, Начисления.

38.

Бизнес-процессы именуйте так же, как документы: в единственном числе.

Примеры

Задание, Согласование, Утверждение, Поручение.

39.

Задачи бизнес-процессов именуйте в единственном числе.

Пример

ЗадачаИсполнителя.

40.

Внешние источники данных именуйте по описанию импортируемых данных. Не используйте лишние слова (Данные..., ИсточникДанных...).

Примеры

ДоговорыУправленческойУчетнойСистемы, ФайлыОсновнойСЭД.

Таблицы внешних источников данных именуйте по общим правилам наименования метаданных.

Примеры

Договоры, Номенклатура.

См. также

• #std474: Имя, синоним, комментарий
• #std706: Ограничения на переименование объектов метаданных

Источник

https://its.1c.ru/db/v8std#content:550