#std474

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

1.1.

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

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

Неправильно

Что

Правильно

Предмет контроля

1.2.

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

  • Сумма (регл.);
  • НДС;
  • МСФО.
1.3.

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

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

Неправильно

Загрузка данных из Эксель Загрузка данных из MS Excel

Правильно

Загрузка данных из Microsoft Excel

1.4.

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

1.5.

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

Неправильно

Для реквизита Владелец в справочнике Файлы оставить синоним Владелец.

Правильно

Для того же реквизита задать синоним Папка или Папка с файлом.

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

1.6.

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

Неправильно

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

Правильно

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

Пример с реквизитами табличной части Товары документа Пересчет товаров.

Неправильно

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

Правильно

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

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

Неправильно

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

Правильно

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

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

2.1.

Имя объекта рекомендуется строить на основе синонима:

  • убрать пробелы и другие недопустимые в имени символы;
  • первые буквы слов сделать прописными.

Неправильно

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

Правильно

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

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

Примеры

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

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

Пример

Для реквизита Значение скидки или наценки имя ЗначениеСкидкиНаценки.

Допустима и обратная ситуация: синоним короче имени, если в синониме убраны последние технические слова.

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

2.2.

Исключение: объекты метаданных с префиксом Удалить.

Не переименовывайте объекты, реквизиты и формы при корректировке синонимов, если действует требование обратной совместимости.

2.3.

Имена объектов метаданных не должны превышать 80 символов.

2.4.

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

2.5.

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

Пример ошибки

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

Комментарий задавайте только когда нужно дать разработчику важное пояснение по объекту.

Пример

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

3.2.

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

4.

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

См. также
Источник

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