Difficulty: starter
Content
Learning Objectives
After reading this article you will be able to:
Know what CamelCase is
Use CamelCase when naming or writing down pages, fields, and functions
CamelCase
CamelCase is a naming convention in which the first letter of each word in a compound word is capitalized. Because we cannot use spaces in page names the CamelCase is used, since this naming convention makes compound names more readable. For example, ReservationCalenderView is easier to read than reservationcalenderview.
Aside from using CamelCase for every word within a compound word, we also capitalize abbreviations. For example: FMB (short for Facility Management Baseline) is capitalized.
FMB specific Reservation pages often start with: FMB.
Page name convention
When making new pages in Workplace we want to use one singular page name convention. More info on the page names is found in the article: /wiki/spaces/KB/pages/27623427).
By following this convention it’s easy to determine what a certain page is used for. Using CamelCase makes the page names easier to read.
A few examples of page names for different Request pages. Even though some seem quite long we can still understand what the page is about and what it is used for.
Function and field name convention
When talking or communicating to a colleague we tend to use the following convention when talking about field names and functions. This helps to quickly understand where to find the field of function.
Functions: [pageName.functionName] e.g. newRequest.create
Field names: [Object.fieldName] e.g. Request.contactId
Summary
Search