Naming agreement

Names of assemblies and namespaces

Assemblies with business-logic

YourCompanyName.ELMA.<Your module name>

Web modules            

YourCompanyName.ELMA.<Your module name>.Web

Models

Entity names

Class names for entities should be singular. For example, TaskPermission, not TaskPermissions.

Property names

Frequently used properties

You can add these properties in the entity editor, the Add default properties context menu.

  • Name
  • CreationDate
  • CreationAuthor
  • ChangeDate
  • ChangeAuthor
  • Comments
  • Questions

General agreements

  • Date of a certain activity: first you write the activity and then the word Date (for example, the date a block is performed is called BlockDate , not  DateBlock).
  • An author of a certain activity: first you write the activity and then word Author (for example, the author of the blocking activity would be BlockAuthor, and not BlockUseror or UserBlock).
  • Use the Status, not the State term to specify the status of an object.

Examples of other properties

  • Subject
  • Description
  • Executor
  • StartDate
  • EndDate
  • Attachments

Enumeration names

For status, use Status, not State. For example, TaskStatus and not StatusTask or TaskState.

Method names in managers

Managers work with a specific entity. That is why you do not need to write the entity’s name in the action methods unless it is necessary. For example, in TaskManager the method for closing a task would be Close, and not CloseTask.