Delen via

Leesbaarheid van codes

Naamgevingsconventies

Algemene naamgevingsconventies

In dit gedeelte worden de naamgevingsconventies voor "camel case" en "Pascal case" beschreven. Als u al bekend bent met deze termen, kunt u verdergaan.

CamelCase

U moet CamelCase (combinatie van hoofdletters en kleine letters) gebruiken voor besturingselementen en variabelen. Bij CamelCase wordt begonnen met een voorvoegsel van kleine letters, worden alle spaties uit object- of variabelenamen verwijderd en is de eerste letter van elk woord na de eerste een hoofdletter. Een besturingselement voor tekstinvoer kan bijvoorbeeld txtUserEmailAddress zijn.

PascalCase

U moet PascalCase gebruiken voor gegevensbronnen. Pascal case wordt soms ook wel 'upper camel case' genoemd. Net als camel case worden hierbij alle spaties verwijderd en wordt de eerste letter van woorden met een hoofdletter geschreven. In tegenstelling tot CamelCase wordt bij PascalCase echter ook het eerste woord met een hoofdletter geschreven. Een veelgebruikte gegevensbron in PowerApps is bijvoorbeeld de Microsoft Office 365 gebruikersconnector, die in uw code Office365Users wordt genoemd.

Schermnamen

Schermnamen moeten het doel van het scherm weerspiegelen, zodat u gemakkelijker door complexe apps in Power Apps Studio kunt navigeren.

Wat minder voor de hand liggend is, is dat schermnamen hardop worden voorgelezen door schermlezers, wat nodig is voor gebruikers met visuele toegankelijkheidsbehoeften. Daarom is het absoluut noodzakelijk dat u duidelijke taal gebruikt om uw schermen een naam te geven en dat de namen spaties en geen afkortingen bevatten. We raden u ook aan de naam te beëindigen met het woord 'Scherm', zodat de context wordt begrepen wanneer de naam wordt aangekondigd.

Hieronder volgt een aantal goede voorbeelden:

  • Home_Screen of Home Screen
  • Search_Screen of Search Screen

Schermafbeelding met een lijst met schermnamen die het beschreven patroon volgen

Deze voorbeeldschermnamen zijn minder begrijpelijk:

  • Home
  • LoaderScreen
  • EmpProfDetails
  • Thrive Help

Namen van besturingselementen

Alle controlenamen op het canvas moeten camel case gebruiken. Ze moeten beginnen met een typebeschrijving van drie tekens, gevolgd door het doel van het besturingselement. Deze aanpak helpt bij het identificeren van het type besturingselement en maakt het eenvoudiger om formules samen te stellen en te zoeken. lblUserName geeft bijvoorbeeld aan dat het besturingselement een label is.

De volgende tabel toont de afkortingen voor veelgebruikte besturingselementen.

Naam besturingselement Afkorting
Badge bdg
Button btn
Besturingselement Camera cam
Canvas can
Card crd
Grafieken chr
Selectievakje chk
Verzameling col
Keuzelijst met invoervak cmb
Onderdeel cmp
Container con
Datums dte
Vervolgkeuzelijst drp
Formulier frm
Galerij gal
Groeperen groep
Kop hdr
HTML-tekst htm
Icon ico
Image img
Infoknop -info
Etiket lbl
Koppeling link
Lijstvak lst
Microfoon mic
Microsoft Stream str
Vorm van paginasectie sec.
Peninvoer pen
Power BI-tegel pbi
Voortgangsbalk pbar
Classificatie rtg
RTF-editor rte
Vormen (rechthoek, cirkel, enzovoort) shp
Slider sld
Tabbladlijst tbl
Table tbl
Tekstinvoer txt
Timer tmr
Toggle tgl
Video vid

Een gedetailleerde lijst met besturingselementen en de eigenschappen ervan wordt beschreven in Referentie voor besturingselementen.

Notitie

Controlenamen moeten uniek zijn binnen een applicatie. Als een besturingselement op meerdere schermen wordt hergebruikt, moet de korte naam van het scherm een achtervoegsel hebben. Bijvoorbeeld, galBottomNavMenuHS, waarbij 'HS' staat voor 'Home Screen'. Deze aanpak maakt het makkelijker om naar het besturingselement te verwijzen in formules op verschillende schermen.

Hieronder volgt een aantal slechte voorbeelden:

  • zipcode
  • Next

Wanneer u uw bedieningselementen consequent een naam geeft, is uw app overzichtelijker in de navigatieweergave en is uw code ook overzichtelijker.

Schermopname van de navigatieweergave met namen van besturingselementen volgens het patroon

Namen van gegevensbronnen

Wanneer u een gegevensbron aan uw toepassing toevoegt, kan de naam niet worden gewijzigd in de Power Apps-app. De naam wordt overgenomen van de bronconnector of gegevensentiteiten die zijn afgeleid van de verbinding.

Hieronder volgt een aantal voorbeelden:

  • Naam overgenomen van de bronconnector: de Office 365-gebruikersconnector heet namedOffice365Users in uw code.
  • Gegevensentiteiten afgeleid van de verbinding: een Microsoft SharePoint-lijst met de naam Employees wordt geretourneerd via de SharePoint-connector. Daarom is de naam van de gegevensbron in uw code Employees. Dezelfde Power Apps-app kan ook dezelfde SharePoint-connector gebruiken om toegang te krijgen tot een SharePoint-lijst met de naam Contractors. In dit geval is de naam van de gegevensbron in de code Contractors.

Zie Overzicht van canvas-app-connectoren voor Power Apps voor meer informatie over connectoren en verbindingen.

Standaardactieconnectors

In standaardactieconnectors die functies beschikbaar stellen, zoals LinkedIn, wordt voor de naam van de gegevensbron en de bijbehorende bewerkingen PascalCase gebruikt. De LinkedIn-gegevensbron heet bijvoorbeeld LinkedIn en heeft een bewerking met de naam ListCompanies.

ClearCollect(
    colCompanies,
    LinkedIn.ListCompanies()
)

Aangepaste connectoren

Aangepaste connectors die worden gebruikt om verbinding te maken met aangepaste API's (Application Programming Interfaces), zoals services of line-of-business-API's die uw bedrijf heeft gemaakt. Ze kunnen door elke maker in uw omgeving worden gemaakt. We raden PascalCase aan voor de naam van de gegevensbron en de bijbehorende bewerkingen. Houd er rekening mee dat de naam van de aangepaste connector en de manier waarop deze PowerApps wordt weergegeven, kunnen verschillen.

Bekijk dit voorbeeld van een aangepaste connector met de naam MS Auction Item Bid API.

Schermafbeelding van een connector met de naam MS Auction Item Bid API

Maar wanneer u via deze connector een verbinding tot stand brengt en deze als gegevensbron aan uw PowerApps app toevoegt, wordt deze weergegeven als AuctionItemBidAPI.

Schermafbeelding van een connector die laat zien dat de naam AuctionItemBidAPI is

Om de reden te achterhalen, kunt u in het OpenAPI-bestand zoeken naar een titelkenmerk dat de tekst Auction Item Bid API bevat.

"info": {
    "version": "v1",
    "title": "Auction Item Bid API"
},

Power Apps verwijdert alle spaties uit deze attribuutwaarde en gebruikt deze als de naam van uw gegevensbron.

Tip

We raden u aan de waarde van dit kenmerk te wijzigen in een naam waarin PascalCase is gebruikt, zoals AuctionItemBidAPI , en deze te gebruiken als de naam van uw aangepaste verbinding. Op die manier zal er geen verwarring ontstaan. Wijzig deze waarde voordat u het OpenAPI bestand importeert om de aangepaste connector te maken.

Notitie

Als u de optie Geheel nieuw maken gebruikt in plaats van een bestaand OpenAPI -bestand te importeren, wordt u door PowerApps gevraagd om de naam van de aangepaste connector. Deze naam wordt gebruikt als de naam van de aangepaste connector en als de waarde van het title-attribuut in het OpenAPI bestand. Zorg ervoor dat u een naam in PascalCase gebruikt, zoals AuctionItemBidAPI om de zaken consistent en eenvoudig te houden.

Excel-gegevenstabellen

PowerApps gebruikt DataTables in Microsoft Excel om verbinding te maken met gegevens in Excel-werkbladen. Houd deze punten in gedachten wanneer u Excel-documenten als gegevensbronnen maakt:

  • Geef uw DataTables beschrijvende namen. De naam staat in de Power Apps-app wanneer u de code schrijft om er verbinding mee te maken.
  • Gebruik één gegevenstabel per werkblad.
  • Geef dezelfde naam aan de DataTable en het werkblad.
  • Gebruik beschrijvende kolomnamen in de DataTables.
  • Gebruik PascalCase. Elk woord van de DataTable-naam moet beginnen met een hoofdletter, bijvoorbeeld EmployeeLeaveRequests.

Ongetypeerde en dynamische objecten

Variabelenamen

Naamgevingsconventies voor variabelen in canvas-apps zijn belangrijk voor het behouden van de leesbaarheid, consistentie en duidelijkheid in uw Power Apps-projecten. Hoewel er geen strikte standaard wordt gehandhaafd, kunt u door een consistente naamgevingsconventie voor uw canvas-app te hanteren, het voor u en andere medewerkers eenvoudiger maken om de variabelen te begrijpen, gebruiken en beheren.

  • Gebruik camel case, waarbij de eerste letter van elk woord een hoofdletter is, behalve het eerste woord.
  • Kies betekenisvolle en beschrijvende namen die het doel of de inhoud van de variabele duidelijk beschrijven. Vermijd al te algemene namen zoals temp of var1. Gebruik in plaats daarvan beschrijvende namen zoals userEmail of totalAmount.
  • Overweeg het gebruik van voor- of achtervoegsels om het type variabele aan te geven. Bijvoorbeeld:
    • strUserName voor een tekst-/tekenreeksvariabele
    • numTotalAmount voor een numerieke variabele
    • boolIsEnabled voor een booleaanse variabele
    • locVarName voor lokale variabelen/contextvariabelen
    • gblVarLoginUser voor algemene variabelen
  • Bepaal of uw variabelen in enkelvoud of meervoud moeten worden genoemd en houd u aan die conventie. Gebruik bijvoorbeeld consequent userCount of users.
  • Vermijd het gebruik van gereserveerde woorden of namen die in conflict kunnen komen met Power Apps functies of trefwoorden. Raadpleeg de Power Apps documentatie voor een lijst met gereserveerde woorden.
  • Overweeg het gebruik van voorvoegsels die context bieden over het gebruik of de reikwijdte van de variabele. Bijvoorbeeld:
    • frm voor formuliervariabelen
    • col voor verzamelingen
    • var voor variabelen voor algemene doeleinden
  • Vermijd speciale tekens. Houd namen alfanumeriek en vermijd speciale tekens of spaties. Gebruik alleen letters en cijfers.

Power Apps laat contextvariabelen en algemene variabelen dezelfde namen delen. Dit kan voor verwarring zorgen omdat uw formules standaard contextvariabelen gebruiken, tenzij de ondubbelzinnig makende operator wordt gebruikt.

Vermijd deze situatie door deze conventies te volgen:

  • Gebruik voorvoegsels met loc voor contextvariabelen.
  • Gebruik voorvoegsels met gbl voor algemene variabelen.
  • De naam na het voorvoegsel moet de intentie/het doel van de variabele aangeven. Er kunnen meerdere woorden worden gebruikt en deze hoeven niet te worden gescheiden door speciale tekens, zoals spaties of onderstrepingstekens, als de eerste letter van elk woord een hoofdletter is.
  • Gebruik CamelCase. Begin de namen van uw variabelen met een voorvoegsel in kleine letters en gebruik vervolgens een hoofdletter voor de eerste letter van elk woord in de naam.

Deze voorbeelden volgen normen en conventies:

  • Algemene variabele:gblFocusedBorderColor

  • Contextvariabele:locSuccessMessage

  • Bereikvariabele:scpRadius

Deze voorbeelden voldoen niet aan de normen en zijn moeilijker te begrijpen:

  • dSub
  • rstFlds
  • hideNxtBtn
  • ttlOppCt
  • cFV
  • cQId

Vermijd korte en cryptische namen van variabelen, zoals EID. Use EmployeeId als alternatief.

Als een app veel variabelen bevat, kunt u eenvoudigweg het voorvoegsel in de formulebalk typen om een ​​lijst met beschikbare variabelen te zien. Als u deze richtlijnen volgt om uw variabelen een naam te geven, kunt u ze gemakkelijk vinden in de formulebalk terwijl u uw app ontwikkelt. Uiteindelijk leidt deze aanpak tot een snellere app-ontwikkeling.

Namen van verzamelingen

  • Geef een beschrijving van de inhoud van de collectie. Denk na over wat de collectie bevat en/of hoe deze wordt gebruikt, en geef deze dienovereenkomstig een naam.
  • Verzamelingen moeten het voorvoegsel col hebben.
  • De naam achter het voorvoegsel moet de intentie of het doel van de verzameling aangeven. Er kunnen meerdere woorden worden gebruikt en deze hoeven niet gescheiden te worden door spaties of onderstrepingstekens, mits de eerste letter van elk woord een hoofdletter is.
  • Gebruik CamelCase. Begin de namen van uw verzamelingen met het voorvoegsel col in kleine letters en gebruik vervolgens een hoofdletter voor de eerste letter van elk woord in de naam.

Deze voorbeelden volgen de naamconventies van de collectie:

  • colMenuItems
  • colThriveApps

Deze voorbeelden volgen de naamgevingsconventies voor verzamelingen niet:

  • orderscoll
  • tempCollection

Tip

Als er veel collecties in de app staan, kunt u gewoon het voorvoegsel in de formulebalk typen om een ​​lijst met de beschikbare collecties te zien. Wat betreft variabelen: als u deze richtlijnen volgt om uw collecties een naam te geven, kunt u ze heel gemakkelijk vinden in de formulebalk terwijl u uw app ontwikkelt. Uiteindelijk leidt deze aanpak tot een snellere app-ontwikkeling.

Opmerkingen en documentatie

Terwijl u code voor uw toepassing schrijft, moet u het belang van uitgebreid commentaar benadrukken. Deze opmerkingen dienen niet alleen als een nuttige gids wanneer u de applicatie maanden later opnieuw bezoekt, maar vormen ook een gebaar van dankbaarheid naar de volgende ontwikkelaar die aan het project meewerkt.

Er zijn twee primaire typen opmerkingen om de duidelijkheid van code te verbeteren: Power Apps ondersteunt twee opmerkingsstijlen: regelopmerkingen, aangegeven met dubbele schuine strepen (//) voor opmerkingen van één regel, en blokopmerkingen ingesloten tussen /* en */ voor annotaties met meerdere regels.

Regelopmerkingen

Als u een dubbele voorwaartse slash (//) toevoegt aan een coderegel in PowerApps, wordt de rest van de regel (inclusief //) aangegeven als een opmerking.

Gebruik regelopmerkingen om de functionaliteit van de volgende code te verduidelijken. Ze kunnen ook dienen om een ​​regel code tijdelijk uit te schakelen, waardoor ze nuttig zijn voor testdoeleinden.

Dit voorbeeld toont het gebruik van regelcommentaar.

// ClearCollect function populates the Expenses2 collection with sample data
ClearCollect(
    Expenses2,
    // Entry 1: Client hosted meet and greet
    {
        Title: "Client hosted meet and greet:",
        ID: "4"
        // additional properties  
    }
)

Blokopmerkingen

Tekst tussen /* en */ wordt herkend als blokopmerking. In tegenstelling tot regelopmerkingen die op één regel van toepassing zijn, kunnen blokopmerkingen meerdere regels bestrijken.

Blokopmerkingen zijn handig voor uitleg die bestaat uit meerdere regels, zoals het documenteren van een codemodulekoptekst. Ze vergemakkelijken ook het tijdelijk uitschakelen van meerdere coderegels tijdens het testen of debuggen.

Voor een optimale organisatie van de code is het raadzaam om opmerkingen toe te voegen nadat u de functie Tekst opmaken hebt gebruikt. Dit is handig als uw commentaar voorafgaat aan een codeblok.

/*
    Patch Operation to Insert Data:
    - Inserts a new employee record into the 'Employee' entity.
    - Adds corresponding department details to the 'Department' entity.
    Note: Ensure that foreign key relationships and dependencies are maintained for data integrity.
*/
Patch(
    Employee,
    Defaults(Employee),
    {
        FirstName: "John",
        LastName: "Doe",
        Position: "Software Developer"
    }
)

De functie Tekst opmaken volgt deze regels voor bestaande opmerkingen:

  1. Als een eigenschap begint met een blokcommentaar, wordt de volgende coderegel eraan toegevoegd.
  2. Als een eigenschap begint met een regelopmerking, wordt de volgende coderegel er niet aan toegevoegd. Anders wordt de code tijdelijk in een opmerking geplaatst.
  3. Regel- en blokopmerkingen elders in de eigenschap worden toegevoegd aan de vorige coderegel.

Maak je geen zorgen over het toevoegen van te veel opmerkingen of opmerkingen die te lang zijn. Alle opmerkingen worden verwijderd wanneer in PowerApps het client-app-pakket wordt gemaakt. Daarom hebben ze geen invloed op de pakketgrootte en vertragen ze de download- of laadtijden van de app niet.

Moderne appontwerper met opmerkingen

In Power Apps wordt het beschouwd als de best practice voor makers om effectief gebruik te maken van opmerkingsfuncties binnen zowel Power Apps Studio als moderne appontwerper.

Voor optimale betrokkenheid bij de Power Apps Studio worden makers geadviseerd commentaar toe te voegen op de volgende manieren:

  1. Klik met de rechtermuisknop op het weglatingsteken ("...") van een item in de structuurweergave.
  2. Klik met de rechtermuisknop op een component in het canvasgebied.
  3. Selecteer de knop "Opmerkingen" die zich op de opdrachtbalk bevindt in de rechterbovenhoek van het scherm.

Wanneer u collega's in opmerkingen vermeldt, wordt aanbevolen om het "@"-symbool te gebruiken, gevolgd door hun naam. Dit leidt tot een notificatie-e-mail voor de getagde collega, waardoor snelle toegang tot de opmerking wordt gegarandeerd. In gevallen waarin een getagde gebruiker geen toegang heeft tot de app, wordt de maker gevraagd de app met deze gebruiker te delen.

Een screenshot van een onkostenapp met een persoon @ vermeld in de opmerking

Inspringen en opmaak

In Power Apps zijn inspringing en opmaak cruciaal voor het behouden van een duidelijke en georganiseerde structuur in uw app. Door best practices te volgen, verbetert u de leesbaarheid van uw formules en besturingselementen.

Formulebalk

Inspringing

Hoewel in Power Apps strikte inspringing niet wordt afgedwongen, kunt u spaties gebruiken om verschillende gedeelten van uw formules visueel van elkaar te scheiden. Druk meerdere keren op de spatiebalk om een ​​inspringingseffect te creëren.

Lijnonderbrekingen

U kunt lange formules opsplitsen in meerdere regels om de leesbaarheid te vergroten. Druk op Enter om een regeleinde in de formulebalk te maken.

Gebruik de opdracht Tekst opmaken

De opdracht 'Tekst opmaken' in de formulebalk is ontworpen om inspringing, tussenruimte en regeleinden toe te passen op uw Power Apps-code. Gebruik de opdracht 'Tekst opmaken' om een ​​uniforme codeerstijl voor uw gehele canvas-app in te stellen, waardoor een efficiënter en foutbestendiger ontwikkelingsproces wordt gegarandeerd.

Schermopname van Power Apps Studio met de opdracht Tekst opmaken gemarkeerd

Volgende stap

Codeoptimalisering