Имя, синоним, комментарий

См. также

1.1. Синоним объекта должен быть определен так, чтобы осмысленно, лаконично описывать объект. Заполняется обязательно.

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

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

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

В частности, если для англоязычного термина нет общепринятого перевода на русский язык, то следует использовать оригинальный англоязычный термин.
Например, неправильно: «Загрузка данных из Эксель»;
правильные варианты: «Загрузка данных из Microsoft Excel», «Загрузка данных из программы MS Excel».

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

1.5. При этом для стандартных реквизитов Родитель и Владелец, следует всегда указывать синонимы, отличные от синонимов по умолчанию. Например, в конфигурации имеется справочник Файлы со стандартным реквизитом Владелец типа СправочникСсылка.ПапкиФайлов. В этом случае
неправильно

• оставлять синоним стандартного реквизита Владелец по умолчанию: «Владелец»;

правильно

• вложить в синоним прикладной смысл: «Папка» или «Папка с файлом».

Другой пример. В то время как для стандартного реквизита Наименование некоторых справочников может вполне подойти синоним по умолчанию «Наименование», в случае со справочником Файлы целесообразнее назначить синоним «Имя файла», а для справочника ФизическиеЛица – дать синоним «ФИО».

См. также: Пользовательские представления объектов, Тексты

1.6. В случае, когда есть два (или более) объекта метаданных со схожим назначением, необходимо, чтобы синонимы каждого объекта полностью описывали каждый объект.

Например, неправильно давать справочникам следующие синонимы:

• Банковские счета,
• Банковские счета контрагентов

правильно:

• Банковские счета организаций,
• и Банковские счета контрагентов

Следует называть эти объекты явным образом, чтобы пользователь не задавался вопросом: «Если в справочнике Банковские счета контрагентов хранится информация о счетах контрагентов, то информация о чьих счетах хранится справочнике Банковские счета?»

Это требование справедливо и для синонимов подчиненных объектов метаданных (реквизитов, табличных частей, измерений, ресурсов и пр.).
Пример с реквизитами табличной части «Товары» документа «Пересчет товаров».
Неправильно:

• Количество
• Количество (по учету)

правильно:

• Количество (в наличии)
• Количество (по учету)

Пример со стандартным реквизитом Наименование и еще одним реквизитом справочника «Номенклатура».
Неправильно:

• Наименование
• Полное наименование

правильно:

• Рабочее наименование
• Наименование для печати

2.1. Имя объекта рекомендуется строить на основе синонима: пробелы и пр. недопустимые в имени символы, удаляются, а первые буквы слов делаются прописными. Например, правильно, когда:

• у справочника НаборыДополнительныхРеквизитовИСведений задан синоним «Наборы дополнительных реквизитов и сведений»
• у общей команды ПрисоединенныеФайлы – синоним «Присоединенные файлы».

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

• ДлительностьОжиданияСервера – синоним «Длительность ожидания сервера (сек)»
• КоличествоЕдиниц – синоним «Количество единиц измерения»
• Обработки.ГрупповоеИзменениеОбъектов.Операции.ИмяРеквизита – синоним «Имя реквизита (свойство)»

Имя также может не включать союзы и предлоги из текста синонима, например: для реквизита ЗначениеСкидкиНаценки синоним «Значение скидки или наценки».

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

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

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

2.2. Имена объектов метаданных верхнего уровня (справочники, документы и пр.) не должны превышать 128 символов.

2.3. Для подчиненных объектов метаданных, таких как реквизиты, измерения, ресурсы рекомендуется не использовать имена, совпадающие с именами объектов-владельцев. Например, измерение Пользователь (типа СправочникСсылка.Пользователи) регистра сведений ИсполнителиЗадач названо некорректно; правильное название измерения, раскрывающее его смысл: Исполнитель.

2.4. Также рекомендуется не использовать имена, которые применяются при именовании таблиц языка запросов (например, Документ, Справочник, РегистрСведений и т.д.). Такие имена могут приводить к ошибкам при исполнении запроса, затрудняют использование конструктора запроса и снижают наглядность текста запроса. Например, выполнение данного запроса вызывает ошибку:

ВЫБРАТЬ 
Сведения.Сведения 
ИЗ 
РегистрСведений.Сведения КАК Сведения

2.5. Исключение из этого правила составляют объекты метаданных с префиксом Удалить.

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

3.2. Комментарий начинается с прописной буквы, точки ставятся только после сокращений.

4. В именах, синонимах и комментариях не допускается использовать букву "ё".

См. также

• Пользовательские представления объектов
• Подсказка и проверка заполнения
• Реквизит "Комментарий" у документов