Соглашения об именовании

Материал из Eludia
(перенаправлено с «Соглашеня об именовании»)
Перейти к: навигация, поиск

Имена типов экранов, таблиц и их полей, а также прочие идентификаторы, используемые в системе следует выбирать, руководствуясь определёнными правилами. Нарушение некоторых из этих правил приводит "всего лишь" к затруднениям в программной поддержке системы, иных – к её неработоспособности.

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

Алфавитные фрагменты должны быть либо основами общеупотребительных слов английского языка в американской орфографии (color), либо, при невозможности подобрать таковую, транскрибированными русскими основами или аббревиатурами (ogrn). Английские словоосновы можно сокращать, особенно при массовом использовании, если это не порождает неоднозначности (xprt вместо expert).

Последний алфавитный фрагмент имени таблицы, как правило, имеет форму множественного числа существительного (waybills, waybill_items).

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

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

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

Идентификаторы, начинающиеся со знака подчёркивания, относятся к ядру Eludia и не должны использоваться для хранения специфических данных приложения.

Персональные инструменты
Пространства имён

Варианты
Действия
Навигация
Разработчику
Администратору
Инструменты