Pick up where you left off on this computer

Resume

 

 

 

Skip Navigation Links.

Naming Conventions - Rules

There are few universally-accepted naming convention rules; however, the following list includes some guidelines that are generally recognised for creating content keywords:

  • Not too short, not too long - Each keyword should give just enough information about what it's used for to be identifiable at a glance. Too little information can cause loss of clarity, while too much information can make your project bloated, unwieldy and more susceptible to typos.
  • Use Upper CamelCase - The best way to identify boundaries between - or delimit - the individual words in a keyword is to capitalise the first letter of each new word. This notation is known as CamelCase, since the uppercase letter at the start of each word is likened to the raised humps on the back of a camel.

When the first letter of the entire keyword is lowercase (e.g. myVariableKeyword), this is referred to as Lower CamelCase. Conversely, when the first letter of a keyword is uppercase, the notation is called Upper CamelCase, or sometimes Pascal Case. KnowledgeKube automatically converts the first letter of all keywords to uppercase; as such, any mention of CamelCase in this guide refers to Pascal Case.

  • Avoid abbreviations - Especially where the shortened word causes ambiguity or loss of meaning. CustomerTotalWindow is preferable to CustTotWin, for example.
  • Avoid ambiguity - Don't use unqualified terms that might have several uses. Rather than DOB1 and DOB2, consider using CustomerDOB and SpouseDOB, so each one is distinguishable by its name.
  • Think ahead - Your project might be quite straightforward now, but bear in mind you may have to add to it later, so try to account for how new additions will affect the comprehensibility of existing content.
  • Use prefixes to denote type - KnowledgeKube content is comprised of various object types, from questions to variables to status elements. As your project grows, you may find yourself with a sizeable list of contents whose keywords adequately describe their purpose, but lack the means to distinguish one type of object from the next. Adding consistent prefixes to your keywords not only helps ensure you are using the correct value at all times, but also groups all keywords of a similar type together for even easier management of project content. For example, you could prefix your variables with VAR to help distinguish them from your Questions, so if your question is called: CustomerFirstName your variable would be called: VARCustomerFirstName.

Again, don’t worry about remembering or understanding them all at this stage, just be mindful of the above when naming elements within your projects, the important thing is to be clear and consistent throughout all of your models and projects. We will be using some of the above techniques as we progress through the course.

PreviousNext

Found a problem or something unclear? Get help or provide feedback on this page by completing this form.

Is two > than four? (true/false)