Naming Conventions

Developers should follow these conventions when naming Callimachus resources.

Identifier

Convention

Case

Example

Namespace prefix

two to six letters

lower

sig

Class

noun

PascalCase

AppDomain

Message class

verb

PascalCase

GetAppResult

Datatype property

role noun

camelCase

typeName

Time property

verb

camelCase

completedOn

Object property

verb

camelCase

hasParent

Message property

noun

camelCase

inputStream

Query parameter

noun

lower case

authordetails

File or directory

- separates

lower case

event-create.xhtml

Singleton resource

_ separates

lower case

main_resource

Other resource

+ separates

lower case

my+resource

Namespace for things

/ ends and separates

lower case

/tools/

Sub-resource

# separates parent resource

lower case

my+resource#rel0

Nested resource

/ separates parent resource

lower case

parent/child

Naming guidelines

  1. Use alphanumeric characters for identifiers (unless convention otherwise indicates).

  2. Keep identifiers simple and descriptive.

  3. Avoid acronyms and abbreviations.

  4. Choose easily readable identifier names.

  5. Favor readability over brevity.

  6. Do not use Hungarian notation, where the variable type can be seen from its name.

  7. Avoid using identifiers that conflict with keywords of widely used programming languages.

  8. Use slash URI identifiers for things and hash URI identifiers for classes and properties.