Namen van pagina's, velden en functies (gebruik CamelCase)
- Lango: Language and translation manager
Moeilijkheidsgraad: starter
Leerdoelen
Na het lezen van dit artikel zul je in staat zijn om:
Weten wat CamelCase is
Gebruik CamelCase bij het benoemen of opschrijven van pagina's, velden en functies
CamelCase
CamelCase is een naamgevingsconventie waarbij de eerste letter van elk woord in een samengesteld woord een hoofdletter is. Omdat we geen spaties kunnen gebruiken in paginanamen wordt de CamelCase gebruikt, omdat deze naamgevingsconventie samengestelde namen leesbaarder maakt. Bijvoorbeeld, Reserveringskalenderweergave is gemakkelijker te lezen dan reserveringskalenderweergave.
Naast het gebruik van CamelCase voor elk woord binnen een samengesteld woord, geven we ook hoofdletters aan afkortingen. Bijvoorbeeld: FMB (afkorting voor Facility Management Baseline) wordt met een hoofdletter geschreven.
FMB specifieke reserveringspagina's beginnen vaak met: FMB.
Conventie voor paginanaam
Bij het maken van nieuwe pagina's in Workplace willen we één enkele conventie voor paginanamen gebruiken. Meer informatie over de paginanamen is te vinden in het artikel: https://spacewell.atlassian.net/wiki/spaces/KB/pages/27623427).
Door deze conventie te volgen is het eenvoudig om te bepalen waar een bepaalde pagina voor gebruikt wordt. Door CamelCase te gebruiken zijn de paginanamen gemakkelijker te lezen.
Een paar voorbeelden van paginanamen voor verschillende Request-pagina's. Hoewel sommige nogal lang lijken, kunnen we nog steeds begrijpen waar de pagina over gaat en waar hij voor wordt gebruikt.
Conventie voor functie- en veldnamen
Wanneer we met een collega praten of communiceren, gebruiken we meestal de volgende conventie wanneer we het hebben over veldnamen en functies. Dit helpt om snel te begrijpen waar je het veld of de functie kunt vinden.
Functies: [pageName.functionName] bijv. newRequest.create
Veldnamen: [Object.fieldName] bijv. Request.contactId
Samenvatting
Zoek op