Соглашение по наименованию

Имена сборок и пространства имен

Сборки с бизнес-логикой

EleWise.ELMA.<Имя вашего модуля>

Веб-модули

EleWise.ELMA.<Имя вашего модуля>.Web

Модели

Имена сущностей

Имена классов для сущностей должны быть в единственном числе. Например, TaskPermission , а не TaskPermissions .

Имена свойств

Часто используемые свойства

Данные свойства можно добавить через редактор сущностей в контекстном меню  Добавить стандартные свойства:

  • Наименование / Имя (Name);
  • Дата создания (CreationDate);
  • Автор создания (CreationAuthor);
  • Дата изменения (ChangeDate);
  • Автор изменения (ChangeAuthor);
  • Комментарии (Comments);
  • Вопросы (Questions).

Общие соглашения

  • дата чего-либо – сначала действие, на конце слово Date (например, дата блокировки –   BlockDate, а не DateBlock);
  • автор какого-либо действия – сначала действие, на конце слово Author (например, автор блокировки – BlockAuthor, а не BlockUser или UserBlock);
  • для обозначения статуса объекта использовать термин Статус (Status), а не Состояние ( State).

Примеры других свойств

  • Тема (Subject);
  • Описание (Description);
  • Исполнитель (Executor);
  • Дата начала (StartDate);
  • Дата завершения (EndDate);
  • Вложения (прикрепленные файлы) (Attachments).

Имена перечислений

Использовать для статусов термин Status, а не State. Например,  TaskStatus, а не StatusTask или TaskState.

Имена методов в менеджерах

Менеджеры работают с конкретной сущностью. Поэтому при отсутствии какой-либо необходимости не нужно писать в методах для действий имя сущности. Например, в  TaskManager  метод закрытия задачи называть  Close, а не CloseTask.