- Naming Convention
Documentation - Naming Convention
To ensure consistency in the naming of documents and document fields, the following
naming convention is used by the Regno Standard.
Each document name will be a single string without any spacing. The first character will be
uppercase with following characters following the Camel case convention.
Examples include ConfigDoc and IdentifyDoc.
Each field name will be a single string without any spacing. The first character
will be lowercase with following characters following the Camel case convention.
Examples include axisValuesX and configDocId.
Each document type field will be abbreviated where possible using the following:
- The word “Configuration” becomes “Config”
- The word “Parameter” becomes “Param”
- The word “Conversion” becomes “Conv”
- The word “Statistic” becomes “Stat”
- The word “Definition” becomes “Def”
- The word “Document” becomes “Doc”
Each document type field is post fixed with the string “Doc”.
Examples include ConfigDoc and EventDefDoc.
For all document fields excluding type, the following is used:
Any field that references another document shall contain the referenced document name
as a postfix including the referenced field. An example
field includes paramDefDocId, which is a field whose value is the id
field value of a ParamDefDoc
Any field that does not reference another document shall not be abbreviated.
Examples include documentInterval and linearRegressionSlope.