Læsbarhed for kode

Kodelæsbarhed er et vigtigt aspekt af appudvikling, der ofte overses. Læsbar kode er nemmere at forstå, vedligeholde og foretage fejlfinding af.

Navngivningskonventioner

Ensartede navngivningskonventioner forbedrer læsbarheden af din kode betydeligt. Det hjælper dig med hurtigt at identificere formålet med hvert element i din app og gør det nemmere at navigere gennem din kodebase.

Generelle navngivningskonventioner

I dette afsnit beskrives navngivningskonventionerne "CamelCase" og "PascalCase". Hvis du allerede er fortrolig med disse termer, kan du springe over.

CamelCase

Brug camel case til kontrolelementer og variabler. CamelCase starter med et præfiks med små bogstaver, fjerner alle mellemrum fra objekt- eller variabelnavne, og gør det første bogstav i hvert efterfølgende ord stort. Et tekstinputkontrolelement kan f.eks. hedde txtUserEmailAddress.

PascalCase

Brug Pascal-sag til datakilder. Pascal case kaldes undertiden "upper camel case." Ligesom camel case fjerner den alle mellemrum og gør det første bogstav i hvert ord stort. I modsætning til CamelCase bruges det første ord dog også som store bogstaver i PascalCase. En almindelig datakilde i Power Apps er f.eks. Connectoren Microsoft Office 365-brugere, der hedder Office365Users i kode.

Skærmnavne

Vælg skærmnavne, der tydeligt viser formålet med skærmen, hvilket gør det nemmere at navigere gennem komplekse apps i Power Apps Studio.

Skærmlæsere læser skærmnavne højt. Brugere med vision tilgængelighedsbehov er afhængige af disse skærmlæsere. Brug almindeligt sprog til skærmnavne, inkluder mellemrum, og undgå forkortelser. Afslut hvert navn med ordet "Screen" for at angive tydelig kontekst, når navnet annonceres.

Her er nogle gode eksempler:

• Home_Screen eller Home Screen
• Search_Screen eller Search Screen

Disse eksempler på skærmnavne er mindre forståelige:

• Home
• LoaderScreen
• EmpProfDetails
• Thrive Help

navne på kontrolelementer

Brug camel case til alle kontrolelementnavne på lærredet. Start med en typebeskrivelse med tre tegn efterfulgt af formålet med kontrolelementet. Denne fremgangsmåde hjælper dig med at identificere typen af kontrolelement og gør det nemmere at oprette formler og søge. For eksempel, lblUserName indikerer, at kontrolelementet er en etiket.

I tabellen nedenfor vises forkortelserne for almindelige kontrolelementer.

En detaljeret liste over kontrolelementer og deres egenskaber er beskrevet i referencen til kontrolelementer.

Her er nogle dårlige eksempler:

• zipcode
• Next

Når du konsekvent navngiver dine kontrolelementer, bliver din app renere i navigationsvisningen, og koden er også renere.

Datakildenavne

Når du føjer en datakilde til dit program, kan du ikke ændre navnet i Power Apps-appen. Navnet er nedarvet fra kildetilslutning eller dataobjekter, der er afledt af forbindelsen.

Her er nogle eksempler:

• Navn, der er nedarvet fra kildeconnectoren: Connectoren Office 365-brugere er navngivet Office365Users i din kode.
• Dataobjekter, der er afledt af forbindelsen: En Microsoft SharePoint-liste ved navn Employees returneres fra connectoren SharePoint. Derfor er Employeesnavnet på datakilden i din kode . Den samme Power Apps-app kan også bruge den samme SharePoint-connector til at få adgang til en SharePoint-liste med navnet Contractors. I dette tilfælde er navnet på datakilden i koden Contractors.

Få mere at vide om connectors og forbindelser i Oversigt over forbindelser til lærredsapps.

Standard-handlingsconnectorer

I standardhandlingsconnectors, der viser funktioner, f.eks. LinkedIn, bruger datakildenavnet og dens handlinger Pascal-kabinet. LinkedIn-datakilden er f.eks. navngivet LinkedIn og har en handling med navnet ListCompanies.

ClearCollect(
    colCompanies,
    LinkedIn.ListCompanies()
)

Brugerdefinerede connectorer

Brug brugerdefinerede connectors til at oprette forbindelse til brugerdefinerede API'er (Application Programming Interfaces), f.eks. tjenester eller line of business-API'er, som din virksomhed opretter. Alle udviklere i dit miljø kan oprette brugerdefinerede connectors. Brug Pascal-case til datakildenavnet og dets operationer. Navnet på den brugerdefinerede connector og den måde, den vises på i Power Apps, kan variere.

Overvej dette eksempel på et brugerdefineret stik, der er navngivet MS Auction Item Bid API.

Når du opretter en forbindelse fra denne connector og føjer den til din Power Apps-app som en datakilde, vises den som AuctionItemBidAPI.

Hvis du vil finde årsagen, skal du kigge i OpenAPI-filen efter en titelattribut, der indeholder teksten Auction Item Bid API.

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

Power Apps Fjerner alle mellemrum fra denne attributværdi og bruger den som navnet på din datakilde.

Excel-datatabeller

Power Apps bruger DataTables i Microsoft Excel til at oprette forbindelse til data i Excel-regneark. Vær opmærksom på følgende, når du opretter Excel-dokumenter som datakilder:

• Giv DataTables beskrivende navne. Navnet findes i Power Apps appen, når du skriver koden for at oprette forbindelse til den.
• Brug én DataTable pr. regneark.
• Giv DataTable og regnearket det samme navn.
• Brug beskrivende kolonnenavne i DataTables.
• Brug Pascal casing. Hvert ord i DataTable-navnet skal starte med store bogstaver, f.eks. EmployeeLeaveRequests.

Variable navne

Navngivningskonventioner for variabler i canvas apps er vigtige for at bevare læsbarhed, ensartethed og klarhed i dine Power Apps projekter. Selvom der ikke håndhæves nogen streng standard, kan du ved at anvende en ensartet navngivningskonvention på tværs af din lærredapp gøre det nemmere for dig og andre samarbejdspartnere at forstå, bruge og administrere variablerne.

• Brug camelCase, hvor det første bogstav i hvert ord skrives med store bogstaver med undtagelse af det første ord.
• Vælg meningsfulde og beskrivende navne, der klart beskriver formålet med eller indholdet af variablen. Undgå alt for generiske navne som temp eller var1. Brug i stedet beskrivende navne som userEmail eller totalAmount.
• Overvej at bruge præfikser eller suffikser til at angive variabeltypen. For eksempel:
  • strUserName for en tekst/strengvariabel
  • numTotalAmount for en numerisk variabel
  • boolIsEnabled til en boolesk variabel
  • locVarName for lokale variabler/kontekstvariabler
  • gblVarLoginUser for globale variabler
• Beslut, om variablerne skal navngives i entals- eller flertalsform, og hold dig til den konvention. Brug f.eks. konsekvent userCount eller users.
• Undgå at bruge reserverede ord eller navne, der kan være i konflikt med Power Apps funktioner eller nøgleord. Tjek Power Apps dokumentationen for en liste over reserverede ord.
• Overvej at bruge præfikser, der giver en kontekst omkring variablens anvendelse eller rækkevidde. Eksempel:
  • frm for formularvariabler
  • col for samlinger
  • var for alsidige variabler
• Undgå specialtegn. Bevar navnene alfanumeriske, og undgå specialtegn eller mellemrum. Brug kun bogstaver og tal.

Power Apps lader kontekstvariabler og globale variabler dele de samme navne. Denne deling kan skabe forvirring, fordi formlerne bruger kontekstvariabler som standard, medmindre du bruger operatoren til fjernelse af flertydige udtryk.

Undgå denne situation ved at følge disse konventioner:

• Foranstille kontekstvariabler med loc.
• Foranstille globale variabler med gbl.
• Navnet efter præfikset skal angive variablens hensigt eller formål. Du kan bruge flere ord uden at skulle adskille dem med specialtegn, f.eks. understregningstegn, hvis du bruger det første bogstav i hvert ord med stort.
• Brug camel case. Begynd variabel-navnene med et præfiks med små bogstaver, og kapitaliser derefter det første bogstav i hvert ord i navnet.

Disse eksempler følger standarder og regler:

• Globale variabler:gblFocusedBorderColor
• Kontekstvariabel:locSuccessMessage
• Omfangsvariabel:scpRadius

Disse eksempler følger ikke standarderne og er sværere at forstå:

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

Undgå navne på korte og kryptiske variabler, f.eks EID. . Brug EmployeeId i stedet.

Når en app har mange variabler, skal du skrive præfikset på formellinjen for at få vist en liste over tilgængelige variabler. Hvis du følger disse retningslinjer for at navngive dine variabler, kan du nemt finde dem på formellinjen, når du udvikler din app. I sidste ende fører denne tilgang til hurtigere og mere effektiv appudvikling.

navne på samlinger

• Brug navne, der beskriver samlingens indhold. Tænk over, hvad samlingen indeholder, og hvordan den bruges, og navngiv den i overensstemmelse hermed.
• Præfiks for samlingsnavne med col.
• Brug navnet efter præfikset til at vise hensigten med eller formålet med samlingen. Du kan bruge flere ord uden mellemrum eller understregningstegn, hvis du bruger det første bogstav i hvert ord med stort.
• Brug camel case. Start dine samlingsnavne med et præfiks med små bogstaver col , og skriv derefter det første bogstav i hvert ord i navnet med stort.

Disse eksempler følger regler for samlingsnavn:

• colMenuItems
• colThriveApps

Disse eksempler følger ikke regler for samlingsnavne:

• orderscoll
• tempCollection

Kommentarer til kodedokumentation

Når du skriver kode til dit programmet, skal du fokusere på at tilføje klare kommentarer. Kommentarer hjælper dig med at forstå koden senere og gøre det nemmere for den næste udvikler at arbejde på projektet.

Power Apps understøtter to kommentartypografier for at gøre din kode tydeligere: linjekommentarer, der bruger dobbelte skråstreger (//) til noter med en linje, og blokkommentarer, der bruger /* og */ til noter med flere linjer.

Linjekommentarer

Tilføj en dobbelt skråstreg (//) til en kodelinje for Power Apps at gøre resten af linjen til en kommentar.

Brug linjekommentarer til at forklare, hvad den næste kodelinje gør. Du kan også bruge dem til midlertidigt at deaktivere en kodelinje til test.

Her er et eksempel på en linjekommentar.

// 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  
    }
)

Blokkommentarer

Tekst mellem /* og */ er en blokkommentar. Blokkommentarer kan dække flere linjer, i modsætning til linjekommentarer, som kun dækker én linje.

Brug blokkommentarer til længere forklaringer, f.eks. dokumentation af en kodemoduloverskrift. Du kan også bruge dem til midlertidigt at deaktivere flere kodelinjer under test eller fejlfinding.

Du kan opnå bedre organisering af kodningen ved at tilføje kommentarer, når du har brugt funktionen Formatér tekst. Denne fremgangsmåde hjælper, når dine kommentarer vises før en kodeblok.

/*
    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"
    }
)

Funktionen Formatér tekst følger disse regler for kommentarer:

1. Hvis en egenskab starter med en blokkommentar, føjes den næste kodelinje til den.
2. Hvis en egenskab starter med en linjekommentar, føjes den næste kodelinje ikke til den. Ellers kommenteres koden.
3. Linje- og blokkommentarer andre steder i egenskaben føjes til den forrige kodelinje.

Du skal ikke bekymre dig om at tilføje for mange eller for lange kommentarer. Power Apps fjerner alle kommentarer, når klientapppakken oprettes. Kommentarer påvirker ikke pakkestørrelsen, appens downloadhastighed eller indlæsningstider.

Moderne appdesigner med kommentarer

I Power Apps skal du bruge kommenteringsfunktionerne i både Power Apps Studio og den moderne appdesigner.

Hvis du vil tilføje kommentarer i Power Apps Studio, skal du bruge disse metoder:

• Højreklik på ellipsen ("...") for et element i trævisningen.
• Højreklik på en komponent i lærredsområdet.
• Vælg knappen Kommentarer på kommandolinjen i øverste højre hjørne af skærmen.

Når du nævner en kollega i en kommentar, skal du bruge symbolet "@" efterfulgt af vedkommendes navn. Denne handling sender en mail med besked til den person, du tagger. Hvis den taggede bruger ikke har adgang til appen, Power Apps bliver du bedt om at dele appen med vedkommende.

Indrykning og formatering

Indrykning og formatering hjælper med at holde din app overskuelig og godt organiseret. Når din kode er formateret korrekt, er den nemmere at læse og forstå.

Indrykning

Power Apps gennemtvinger ikke streng indrykning. Brug mellemrum til at adskille forskellige afsnit i formlerne. Tryk flere gange på mellemrumstasten for at oprette en indrykning.

Linjeskift

Opdel lange formler på flere linjer for at gøre dem nemmere at læse. Tryk på Enter for at tilføje et linjeskift på formellinjen.

Brug kommandoen Formater tekst

Kommandoen Formatér tekst på formellinjen føjer indrykning, afstand og linjeskift til din Power Apps-kode. Brug kommandoen Formatér tekst til at bevare en ensartet kodningstypografi i din lærredsapp og til at forhindre fejl.

Relaterede oplysninger

• Brug ensartede navngivningskonventioner i Power Automate-cloudflow
• Byg læsbare og vedligeholdbare scripts i Power Automate-skrivebordsflow

Næste trin