Kodens läsbarhet

Namngivningskonventioner

Allmänna namngivningskonventioner

Det här avsnittet beskriver namngivningskonventionerna kamelnotation och Pascal-notation. Om du redan är bekant med termerna kan du hoppa över.

Kamelnotation

Du bör använda kamelnotation för kontroller och variabler. Kamelnotation börjar med ett prefix med gemener, tar bort alla blanksteg från objekt- eller variabelnamn och använder versaler för den första bokstaven i varje ord efter det första. En textindatakontroll kan till exempel ha namnet txtUserEmailAddress.

Pascal-notation

Du bör använda Pascal-notation till datakällor. Pascal case kallas ibland för ”upper camel case”. Precis som camel case tar det bort alla mellanrum och versaliserar den första bokstaven i varje ord, inklusive det första. Till skillnad från kamelnotation har Pascal-notation även versal i det första ordet. En vanlig datakälla i PowerApps är till exempel anslutningsprogrammet Microsoft Office 365 Användare som har namnet Office365Users i din kod.

Skärmnamn

Skärmnamnen måste avspegla syftet med skärmen så att det blir enklare att navigera genom komplexa appar i Power Apps Studio

Det som är mindre uppenbart är att skärmnamn läses av skärmläsare, som behövs för användare som har synhjälpmedelsbehov. Därför är det viktigt att du använder vanligt språk för att namnge skärmarna och att namnen inte innehåller blanksteg eller förkortningar. Dessutom rekommenderar vi att du avslutar namnet med ordet ”skärm”, så att sammanhanget blir starkt när namnet läses upp.

Här följer några goda exempel:

• Home_Screen eller Home Screen
• Search_Screen eller Search Screen

Dessa exempel på skärmnamn är mindre begripliga:

• Home
• LoaderScreen
• EmpProfDetails
• Thrive Help

Kontrollnamn

Alla kontrollnamn på arbetsytan måste ha kamelnotation. De måste börja med en typbeskrivning med tre tecken följt av syftet med kontrollen. Den här metoden hjälper till att identifiera kontrolltypen gör det enklare att skapa formler och söka. lblUserName anger till exempel att kontrollen är en etikett.

Följande tabell visar förkortningar för vanliga kontroller.

Kontrollnamn	Förkortning
Aktivitetsikon	bdg
Knapp	btn
Kamerakontroll	cam
Arbetsyta	can
Kort	crd
Diagram	chr
Kryssruta	chk
Samling	col
Kombinationsruta	cmb
Komponent	cmp
Behållare	con
Datum	dte
Listruta	drp
Formulär	frm
Galleri	gal
Grupp	grp
Rubrik	hdr
Html-text	htm
Ikon	ico
Bild	img
Informationsknapp	info
Etikett	lbl
Länk	lnk
Listruta	lst
Mikrofon	mic
Microsoft Stream	str
Form på sidavsnitt	sek
Pennindata	pen
Power BI-panel	pbi
Förloppsindikator	pbar
Rating	rtg
Rich Text Editor	rte
Former (rektanglar, cirklar o.s.v. )	shp
Skjutreglage	sld
Fliklista	tbl
Register	tbl
Textinmatning	txt
Timer	tmr
Toggle	tgl
Video	vid

Detaljerad lista med kontroller och deras egenskaper beskrivs i referensen Kontroller.

Obs

Kontrollnamn måste vara unika i ett program. Om en kontroll återanvänds på flera skärmar måste skärmens kortnamn ha ett suffix. Till exempel, galBottomNavMenuHS där ”HS” betyder ”Startkärm”. Den här metoden gör det enklare att referera till kontrollen i formler på olika skärmar.

Här följer några dåliga exempel:

• zipcode
• Next

Om du ger kontrollerna konsekventa namn blir appen renare i navigeringsvyn och även koden blir renare.

Namn på datakälla

När du lägger datakälla i ditt program går det inte att ändra namnet i Power Apps-appen. Namnet ärvs från källanslutningsprogrammet eller dataentiteterna som härleds från anslutningen.

Här följer några exempel:

• Namn ärvt från källanslutningsprogrammet : Anslutningsprogrammet Office 365 Användare har namnet Office365Users i din kod.
• Dataentiteter härledda från anslutningen: En Microsoft SharePoint-lista kallad Employees returneras från SharePoint-anslutningsprogrammet. Därför är datakällans namn i koden Employees. Samma Power Apps-app kan också använda samma SharePoint-anslutningsprogram för åtkomst till en åt en SharePoint-lista med namnet Contractors. I det här fallet är datakällans namn i koden Contractors.

Mer information om anslutningsprogram och anslutningar finns i Översikt med anslutningsprogram för arbetsyteappar för Power Apps.

Anslutningsprogram för standardåtgärder

I anslutningsprogram för standardåtgärder som visar funktioner, såsom LinkedIn, använder namn på datakälla och dess åtgärder Pascal-notation. LinkedIn-datakällan har namnet LinkedIn och har en åtgärd med namnet ListCompanies.

ClearCollect(
    colCompanies,
    LinkedIn.ListCompanies()
)

Anpassade anslutningsprogram

Anpassade anslutningsprogram som används till att ansluta till API:er, t.ex. tjänster eller affärsprogram-API:er som ditt företag har skapat. De kan skapas av alla utvecklare i miljön. Vi rekommenderar Pascal-notation för datakällans namn och dess åtgärder. Tänk bara på att det Anpassade anslutningsprogrammets namn och hur det visas i PowerApps kan vara olika.

Överväg det här exemplet på ett Anpassat anslutningsprogram med namnet MS Auction Item Bid API.

Men när du skapar en anslutning från det här anslutningsprogrammet och lägger till det i PowerApps-appen som datakälla visas den som AuctionItemBidAPI.

Ta reda på orsaken genom söka inne i OpenAPI-filen efter ett rubrikattribut som innehåller texten Auction Item Bid API.

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

Power Apps tar bort alla blanksteg från det här attributvärdet och använder det som namn på datakällan.

Tips!

Vi rekommenderar att du ändrar värdet för attributet till ett namn med Pascal-notation såsom AuctionItemBidAPI och använder det som namn på din Anpassade anslutning. På det sättet uppstår ingen förvirring. Ändra värdet innan du importerar OpenAPI-filen för att skapa det Anpassade anslutningsprogrammet.

Obs

Om du använder alternativet Skapa från tomt i stället för att importera en befintlig OpenAPI-fil ber PowerApps om det Anpassade anslutningsprogrammets namn. Det här namnet används både som namn på det Anpassade anslutningsprogrammet och som värde för rubrikattributet i OpenAPI-filen. Du måste använd namn med Pascal-notation såsom AuctionItemBidAPI för konsekvens och enkelhet.

Excel DataTables

PowerApps använder DataTables i Microsoft Excel för att ansluta till data i Excel-kalkylblad. Tänk på det här när du skapar Excel-dokument som datakällor:

• Ge dina DataTables beskrivande namn. Namnet finns i Power Apps-appen när du skriver koden för att ansluta till den.
• Använd en DataTable per kalkylblad.
• Ange samma namn på DataTable och kalkylbladet.
• Använd beskrivande kolumnnamn i DataTables.
• Använd Pascal-notation. Varje ord iDataTable-namnet måste börja på stor bokstav, till exempel EmployeeLeaveRequests.

Variabelnamn

Namngivningskonventioner för variabler i arbetsyteappar är viktiga för att säkerställa läsbarhet, enhetlighet och tydlighet i dina Power Apps-projekt. Även om ingen strikt standard tillämpas kan en konsekvent namngivningskonvention i din arbetsyteapp göra det enklare för dig och andra medarbetare att förstå, använda och hantera variablerna.

• Använd kamelnotation där varje ord förutom det första ordet börjar på versaler.
• Välj meningsfulla och beskrivande namn som klart beskriver syftet med eller innehållet i variabeln. Undvik för allmänna namn såsom temp eller var1. Använd i stället beskrivande namn såsom userEmail eller totalAmount.
• Överväg att använda prefix eller suffix för att ange variabeltyp. Till exempel:
  • strUserName för en text-/strängvariabel
  • numTotalAmount för en numerisk variabel
  • boolIsEnabled för en boolesk variabel
  • locVarName för lokala variabler/kontextvariabler
  • gblVarLoginUser för globala variabler
• Bestäm om variablerna namnges i singular- eller pluralform och håller sig till den regeln. Använd till exempel konsekvent userCount eller users.
• Undvik att använda reserverade ord eller namn som kan hamna i konflikt med funktioner eller nyckelord i Power Apps. Se Power Apps dokumentation för en lista med reserverade ord.
• Överväg att använda prefix som ger sammanhang om variabelns användning eller omfattning. Till exempel:
  • frm för formulärvariabler
  • col för samlingar
  • var för allmänna variabler
• Undvik specialtecken. Använd alfanumeriska namn och undvik specialtecken eller blanksteg. Använd bokstäver och siffror.

Power Apps tillåter att kontextvariabler och globala variabler har samma namn. Det kan orsaka förvirring eftersom formler använder kontextvariabler som standard såvida inte operatorn disambiguation används.

Undvik den här situationen genom att följa dessa konventioner:

• Ge kontextvariabler prefixet loc.
• Ge globala variabler prefixet gbl.
• Namnet efter prefixet måste ange avsikten/syftet med variabeln. Flera ord kan användas och behöver inte avgränsas med specialtecken, till exempel blanksteg eller understreck, om den första bokstaven i varje ord är en versal.
• Använd kamelnotation. Börja variabelnamnen med ett prefix med gemener och använd sedan stor bokstav för första bokstaven för varje ord i namnet.

Följande exempel följer standarder och konventioner:

• Global variabel:gblFocusedBorderColor

• Kontextvariabel:locSuccessMessage

• Omfattningsvariabel :scpRadius

De här exemplen följer inte standarderna och är svårare att förstå:

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

Undvik korta och kryptiska namn såsom EID. Använd i stället Use EmployeeId.

När det finns många variabler i en app kan du helt enkelt skriva prefixet i formelfältet om du vill visa en lista med tillgängliga variabler. Om du följer de här riktlinjerna för att namnge variablerna kan du enkelt hitta dem i formelfältet när du utvecklar appen. Den här metoden leder till snabbare apputveckling.

Samlingsnamn

• Beskriv innehållet i samlingen. Tänk på vad samlingen innehåller och/eller hur den används och ge den sedan ett namn.
• Samlingar måste ha prefixet col.
• Namnet efter prefixet måste ange avsikten eller syftet med samlingen. Flera ord kan användas och behöver inte avgränsas med specialtecken eller understreck om den första bokstaven i varje ord är en versal.
• Använd kamelnotation. Börja samlingsnamnen med ett prefix med gemener och använd sedan stor bokstav för första bokstaven för varje ord i namnet.

Dessa exempel följer namngivningskonventionerna för samlingsnamn:

• colMenuItems
• colThriveApps

Dessa exempel följer inte namngivningskonventionerna för samlingsnamn:

• orderscoll
• tempCollection

Tips!

När det finns många samlingar i appen kan du helt enkelt skriva prefixet i formelfältet om du vill visa en lista med tillgängliga samlingar. När det gäller variabler, om du följer dessa riktlinjer för att namnge dina samlingar, kommer du enkelt att kunna hitta dem i formelfältet när du utvecklar din app. Den här metoden leder till snabbare apputveckling.

Kommentarer och dokumentation

När du skriver kod för ditt program fokuserar du på att lägga till tydliga kommentarer. Kommentarer hjälper dig att förstå koden senare och gör det enklare för nästa utvecklare att arbeta med projektet.

Power Apps har stöd för två kommentarsformat för att göra koden tydligare: radkommentarer, som använder dubbla snedstreck (//) för enradiga anteckningar, och blockkommentarer, som använder /* och */ för flerradiga anteckningar.

Radkommentarer

Lägg till ett dubbelt snedstreck (//) på valfri kodrad i Power Apps för att göra resten av raden till en kommentar.

Använd radkommentarer för att förklara vad nästa kodrad gör. Du kan också använda dem för att tillfälligt inaktivera en kodrad för testning.

Här är ett exempel på en radkommendar.

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

Blockkommentarer

Text mellan /* och */ är en blockkommentar. Blockkommentarer kan täcka flera rader, till skillnad från radkommentarer, som bara täcker en rad.

Använd blockkommentarer för längre förklaringar, till exempel för att dokumentera en kodmodulrubrik. Du kan också använda dem för att tillfälligt inaktivera flera rader kod under testning eller felsökning.

Om du vill ha bättre kodorganisation kan du lägga till kommentarer när du har använt funktionen Formatera text. Detta hjälper om dina kommentarer kommer före ett kodblock.

/*
    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 Formatera text följer dessa regler för kommentarer:

1. Om en egenskap börjar med en blockkommentar läggs nästa kodrad till i den.
2. Om en egenskap börjar med en radkommentar läggs inte nästa kodrad till i den. Annars kommenteras koden ut.
3. Rad- och blockkommentarer på andra ställen i egenskapen läggs till i föregående kodrad.

Oroa dig inte för att lägga till för många eller för långa kommentarer. Power Apps tar bort alla kommentarer när klientappaketet skapas, så att kommentarerna inte påverkar paketstorleken eller gör appnedladdningar eller inläsningstider långsammare.

Modern appdesigner med kommentarer

I Power Apps är det bäst att använda kommentarsfunktioner i både Power Apps Studio och Modern appdesigner.

Om du vill lägga till kommentarer i Power Apps Studio använder du följande metoder:

1. Högerklicka på ellipsen (…) för valfritt objekt i trädvyn.
2. Högerklicka på en komponent på arbetsytan.
3. Välj knappen Kommentarer längst upp till höger på kommandofältet uppe till höger på skärmen.

När du nämner en kollega i en kommentar, använd "@"-symbolen följt av deras namn. Då skickas ett e-postmeddelande till personen du taggar. Om den taggade användaren inte har åtkomst till appen Power Apps uppmanas du att dela appen med dem.

Indrag och formatering

I Power Apps hjälper indrag och formatering till att hålla din app tydlig och organiserad. Genom att följa bästa praxis blir dina formler och kontroller lättare att läsa.

Formelfält

Indrag

Power Apps tillämpar inte strikt indrag, men du kan använda blanksteg för att avgränsa olika avsnitt i formlerna. Tryck på mellanslagstangenten flera gånger för att skapa ett indrag.

Radbrytningar

Dela upp långa formler i flera rader för att göra dem lättare att läsa. Tryck på Retur om du vill lägga till en radbrytning i formelfältet.

Använda kommandot Formatera text

Kommandot "Formatera text" i formelfältet lägger till indrag, avstånd och radbrytningar i Power Apps-koden. Använd kommandot "Formatera text" för att hålla en konsekvent kodningsstil i din arbetsyteapp och förhindra fel.

Gå vidare

Kodoptimering