Lizibilitatea codului

Convenții de denumire

Convenții generale de denumire

Această secțiune descrie convențiile de denumire pentru „camel case” și „casel case”. Dacă sunteți deja familiarizați cu acești termeni, puteți trece peste.

Carcasă de cămilă

Ar trebui să folosești camel case pentru controale și variabile. Litera „camel” începe cu un prefix cu literă mică, elimină toate spațiile din numele obiectelor sau variabilelor și scrie cu majusculă prima literă a fiecărui cuvânt după prima. De exemplu, un control de introducere a textului ar putea fi denumit txtUserEmailAddress.

Cazul Pascal

Ar trebui să utilizați cazul Pascal pentru sursele de date. Cazul Pascal este uneori denumit „cazul majusculă”. La fel ca în cazul camel, elimină toate spațiile și scrie cu majusculă prima literă a cuvintelor. Totuși, spre deosebire de cazul cămilei, cazul Pascal scrie și el cu majusculă primul cuvânt. De exemplu, o sursă de date comună în PowerApps este conectorul Microsoft Office 365 Utilizatori, care în codul dvs. este denumit Office365Utilizatori.

Nume de ecran

Numele de ecran ar trebui să reflecte scopul ecranului, astfel încât să fie mai ușor să navigați prin aplicații complexe Power Apps Studio.

Ceea ce este mai puțin evident este că numele de utilizator sunt citite cu voce tare de cititoarele de ecran, care sunt necesare pentru utilizatorii cu nevoi de accesibilitate vizuală. Prin urmare, este imperativ să folosiți un limbaj simplu pentru a denumi ecranele și ca numele să includă spații și fără abrevieri. De asemenea, vă recomandăm să încheiați numele cu cuvântul „Screen”, astfel încât contextul să fie înțeles atunci când numele este anunțat.

Iată câteva exemple bune:

• Home_Screen sau Home Screen
• Search_Screen sau Search Screen

Aceste exemple de nume de utilizator sunt mai puțin ușor de înțeles:

• Home
• LoaderScreen
• EmpProfDetails
• Thrive Help

Numele controalelor

Toate numele controalelor de pe pânză ar trebui să folosească litera „camel case”. Acestea ar trebui să înceapă cu un descriptor de tip din trei caractere, urmat de scopul controlului. Această abordare ajută la identificarea tipului de control și facilitează construirea de formule și căutarea. De exemplu, lblUserName indică faptul că controlul este o etichetă.

Următorul tabel prezintă abrevierile pentru controalele comune.

Numele controlului	Abreviere
Ecuson	clădire
Button	btn
Controlul camerei	cameră
Pânză	poate
Card	card
Diagrame	cronologie
Casetă de selectare	pui
Colecție	col
Casetă combo	cmb
Componentă	cmp
Container	con
Date	dată
Listă verticală	drp
Formular	De la
Galerie	fată
Grupare	grup
Antet	HDR
Text HTML	htm
Icon	icoană
Image	imagine
Buton Informații	informații
Eticheta	lbl
Link	link
Casetă listă	listă
Microfon	microfon
Microsoft Stream	str
Forma secțiunii de pagină	secunde
Intrare cu stilou	stilou
Dală Power BI	PBI
Bară de progres	Bară de presiune
Rating	rtg
Editor de text îmbogățit	rte
Forme (dreptunghi, cerc etc.)	shp
Cursor	sld
Listă de file	masă
Table	masă
Introducere text	txt
Cronometru	tmr
Toggle	tgl
Videoclip	videoclip

Lista detaliată a controalelor și proprietățile acestora este descrisă în Referința controalelor.

Notă

Numele controalelor trebuie să fie unice în întreaga aplicație. Dacă un control este reutilizat pe mai multe ecrane, numele scurt al ecranului trebuie să aibă un sufix. De exemplu, galBottomNavMenuHS, unde „HS” înseamnă „Ecran principal”. Această abordare facilitează referirea la control în formule pe mai multe ecrane.

Iată câteva exemple proaste:

• zipcode
• Next

Când denumești controalele în mod constant, aplicația este mai curată în vizualizarea de navigare, iar codul este și el mai curat.

Numele surselor de date

Când adăugați o sursă de date în aplicație, numele nu poate fi modificat în aplicație. Power Apps Numele este moștenit de la conectorul sursă sau de la entitățile de date derivate din conexiune.

Iată câteva exemple:

• Nume moștenit de la conectorul sursă: Conectorul Office 365 Utilizatori este denumit în codul dvs. Office365Utilizatori.
• Entități de date derivate din conexiune: O listă Microsoft SharePoint numită Employees este returnată de conectorul SharePoint . Prin urmare, numele sursei de date din codul dvs. este Angajați. Aceeași aplicație poate utiliza, de asemenea, același conector pentru a accesa o listă numită. Power Apps SharePoint SharePoint Contractors În acest caz, numele sursei de date din cod este Contractors.

Pentru mai multe informații despre conectori și conexiuni, consultați Prezentare generală a conectorilor pentru aplicațiile canvas pentru Power Apps.

Conectori de acțiune standard

În conectorii de acțiune standard care expun funcții, cum ar fi LinkedIn, numele sursei de date și operațiunile acesteia utilizează alfabetul Pascal cu majuscule/minuscule. De exemplu, sursa de date LinkedIn se numește LinkedIn și are o operațiune numită ListCompanies.

ClearCollect(
    colCompanies,
    LinkedIn.ListCompanies()
)

Conectori particularizați

Conectori personalizați utilizați pentru conectarea la interfețe de programare a aplicațiilor (API) personalizate, cum ar fi servicii sau API-uri de linie de afaceri create de compania dvs. Acestea pot fi create de orice producător din mediul tău. Recomandăm utilizarea alfabetului Pascal pentru numele sursei de date și operațiunile acesteia. Rețineți însă că numele conectorului personalizat și modul în care apare în PowerApps pot diferi.

Luați în considerare acest exemplu de conector personalizat numit MS Auction Item Bid API.

Dar când creați o conexiune de la acest conector și o adăugați la aplicația dvs. ca sursă de date, aceasta apare ca PowerApps . AuctionItemBidAPI

Pentru a descoperi motivul, puteți căuta în fișierul OpenAPI un atribut title care conține textul Auction Item Bid API.

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

Power Apps elimină toate spațiile din valoarea acestui atribut și îl folosește ca nume al sursei de date.

Sfat

Vă recomandăm să schimbați valoarea acestui atribut cu un nume scris cu majuscule/minuscule în Pascal, cum ar fi AuctionItemBidAPI , și să îl utilizați ca nume al conexiunii personalizate. În felul acesta, nu va exista nicio confuzie. Modificați această valoare înainte de a importa fișierul OpenAPI pentru a crea conectorul personalizat.

Notă

Dacă utilizați opțiunea Creare dintr-un fișier necompletat în loc să importați un fișier OpenAPI existent, PowerApps vă va solicita numele conectorului personalizat. Acest nume va fi folosit atât ca nume al conectorului personalizat, cât și ca valoare a atributului title din fișierul OpenAPI . Asigurați-vă că folosiți un nume scris cu majuscule/minuscule în Pascal, cum ar fi AuctionItemBidAPI , pentru a menține consecvența și simplitatea lucrurilor.

Tabele de date Excel

PowerApps folosește DataTables în Microsoft Excel pentru a se conecta la datele din foile de calcul Excel. Rețineți aceste aspecte atunci când creați documente Excel ca surse de date:

• Dați tabelelor DataTable nume descriptive. Numele se află în aplicație atunci când scrii codul pentru a te conecta la aceasta. Power Apps
• Folosește un DataTable per foaie de lucru.
• Dați același nume tabelului DataTable și foii de calcul.
• Folosiți nume descriptive ale coloanelor în DataTables.
• Folosește carcasa Pascal. Fiecare cuvânt din numele DataTable trebuie să înceapă cu o literă majusculă, cum ar fi EmployeeLeaveRequests.

Nume de variabile

Convențiile de denumire pentru variabilele din aplicațiile canvas sunt importante pentru menținerea lizibilității, consecvenței și clarității în proiectele dumneavoastră. Power Apps Deși nu se impune niciun standard strict, adoptarea unei convenții de denumire consecvente în aplicația dvs. pe pânză poate facilita înțelegerea, utilizarea și gestionarea variabilelor de către dvs. și alți colaboratori.

• Se folosește majuscula, unde prima literă a fiecărui cuvânt se scrie cu majusculă, cu excepția primului cuvânt.
• Alegeți nume semnificative și descriptive care descriu clar scopul sau conținutul variabilei. Evitați nume prea generice precum temp sau var1. În schimb, folosiți nume descriptive precum userEmail sau totalAmount.
• Luați în considerare utilizarea prefixelor sau sufixelor pentru a indica tipul de variabilă. De exemplu:
  • strUserName pentru o variabilă text/șir de caractere
  • numTotalAmount pentru o variabilă numerică
  • boolIsEnabled pentru o variabilă booleană
  • locVarName pentru variabile locale/variabile de context
  • gblVarLoginUser pentru variabile globale
• Decideți dacă variabilele ar trebui denumite la singular sau la plural și respectați această convenție. De exemplu, utilizați în mod constant userCount sau users.
• Evitați utilizarea cuvintelor sau numelor rezervate care ar putea intra în conflict cu funcții sau cuvinte cheie. Power Apps Consultați documentația pentru o listă de cuvinte rezervate. Power Apps
• Luați în considerare utilizarea prefixelor care oferă context despre utilizarea sau domeniul de aplicare al variabilei. De exemplu:
  • frm pentru variabile de formular
  • col pentru colecții
  • var pentru variabile de uz general
• Evitați caracterele speciale. Păstrați numele alfanumerice și evitați caracterele speciale sau spațiile. Rămâi la litere și cifre.

Power Apps haideți ca variabilele de context și variabilele globale să aibă aceleași nume. Acest lucru poate cauza confuzie deoarece formulele utilizează variabile de context în mod implicit, cu excepția cazului în care se utilizează operatorul de dezambiguizare .

Evitați această situație respectând aceste convenții:

• Prefixați variabilele de context cu loc.
• Prefixați variabilele globale cu gbl.
• Numele de după prefix ar trebui să indice intenția/scopul variabilei. Se pot folosi mai multe cuvinte și nu trebuie separate prin caractere speciale, cum ar fi spații sau sublinieri, dacă prima literă a fiecărui cuvânt este scrisă cu majusculă.
• Folosește carcasă Camel. Începeți numele variabilelor cu un prefix cu litere mici, apoi scrieți cu majusculă prima literă a fiecărui cuvânt din nume.

Aceste exemple respectă standardele și convențiile:

• Variabilă globală:gblFocusedBorderColor

• Variabilă de context:locSuccessMessage

• Variabilă de domeniu:scpRadius

Aceste exemple nu respectă standardele și sunt mai greu de înțeles:

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

Evitați nume de variabile scurte și criptice, cum ar fi EID. Use EmployeeId în schimb.

Când există mai multe variabile într-o aplicație, puteți pur și simplu să tastați prefixul în bara de formule pentru a vedea o listă a variabilelor disponibile. Dacă urmați aceste instrucțiuni pentru a denumi variabilele, le puteți găsi cu ușurință în bara de formule pe măsură ce dezvoltați aplicația. În cele din urmă, această abordare duce la o dezvoltare mai rapidă a aplicațiilor.

Numele de colecție

• Fiți descriptivi în ceea ce privește conținutul colecției. Gândește-te la ce conține colecția și/sau cum este utilizată, apoi denumește-o în consecință.
• Colecțiile ar trebui să aibă prefixul col.
• Numele de după prefix ar trebui să indice intenția sau scopul colecției. Se pot folosi mai multe cuvinte și nu trebuie separate prin spații sau sublinieri, dacă prima literă a fiecărui cuvânt este scrisă cu majusculă.
• Folosește carcasă Camel. Începeți numele colecțiilor cu prefixul „col” cu majusculă, apoi scrieți cu majusculă prima literă a fiecărui cuvânt din nume.

Aceste exemple respectă convențiile de denumire a colecțiilor:

• colMenuItems
• colThriveApps

Aceste exemple nu respectă convențiile de denumire a colecțiilor:

• orderscoll
• tempCollection

Sfat

Când există mai multe colecții în aplicație, puteți pur și simplu să tastați prefixul în bara de formule pentru a vedea o listă a colecțiilor disponibile. În ceea ce privește variabilele, dacă urmați aceste instrucțiuni pentru a denumi colecțiile, le veți putea găsi cu ușurință în bara de formule pe măsură ce dezvoltați aplicația. În cele din urmă, această abordare duce la o dezvoltare mai rapidă a aplicațiilor.

Comentarii și documentație

Când scrii cod pentru aplicația ta, concentrează-te pe adăugarea de comentarii clare. Comentariile te ajută să înțelegi codul mai târziu și îi facilitează următorului dezvoltator lucrul la proiect.

Power Apps acceptă două stiluri de comentarii pentru a face codul mai clar: comentarii pe linie, care utilizează bare oblice duble înainte (//) pentru notele pe o singură linie și comentarii pe bloc, care utilizează /* și */ pentru notele pe mai multe linii.

Comentarii pe rând

Adăugați o bară oblică dublă înainte (//) la orice linie de cod din Power Apps pentru a transforma restul liniei într-un comentariu.

Folosește comentarii pe linie pentru a explica ce face următoarea linie de cod. De asemenea, le puteți folosi pentru a dezactiva temporar o linie de cod pentru testare.

Iată un exemplu de comentariu pe o linie.

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

Blocați comentariile

Textul dintre /* și */ este un comentariu bloc. Comentariile bloc pot acoperi mai multe rânduri, spre deosebire de comentariile pe rând, care acoperă doar un rând.

Folosește comentarii în bloc pentru explicații mai lungi, cum ar fi documentarea unui antet de modul de cod. De asemenea, le puteți folosi pentru a dezactiva temporar mai multe linii de cod în timpul testării sau depanării.

Pentru o mai bună organizare a codului, adăugați comentarii după ce utilizați funcția Formatare text. Acest lucru este util dacă comentariile apar înaintea unui bloc de cod.

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

Funcția Formatare text respectă aceste reguli pentru comentarii:

1. Dacă o proprietate începe cu un comentariu de bloc, următoarea linie de cod este adăugată la aceasta.
2. Dacă o proprietate începe cu un comentariu pe o linie, următoarea linie de cod nu este adăugată la aceasta. Altfel, codul este comentat.
3. Comentariile la nivel de linie și bloc din altă parte a proprietății sunt adăugate la linia anterioară de cod.

Nu vă faceți griji dacă adăugați prea multe sau prea lungi comentarii. Power Apps elimină toate comentariile atunci când creează pachetul aplicației client, astfel încât comentariile să nu afecteze dimensiunea pachetului și să nu încetinească descărcările sau timpii de încărcare a aplicației.

Designer de aplicații moderne cu comentarii

În Power Apps, este recomandat să utilizați funcțiile de comentarii atât în Power Apps Studio , cât și în Modern App Designer.

Pentru a adăuga comentarii în Power Apps Studio, utilizați aceste metode:

1. Faceți clic dreapta pe punctele de suspensie („...”) ale oricărui element din vizualizarea arborescentă.
2. Faceți clic dreapta pe o componentă din zona pânzei.
3. Selectați butonul „Comentarii” situat în bara de comenzi din colțul din dreapta sus al ecranului.

Când menționezi un coleg într-un comentariu, folosește simbolul „@” urmat de numele său. Aceasta trimite un e-mail de notificare persoanei pe care o etichetezi. Dacă utilizatorul etichetat nu are acces la aplicație, Power Apps vă solicită să partajați aplicația cu acesta.

Indentare și formatare

În Power Apps, indentarea și formatarea ajută la menținerea aplicației clare și organizate. Respectarea celor mai bune practici face ca formulele și controalele să fie mai ușor de citit.

Bară de formule

Indentare

Power Apps nu impune indentare strictă, dar puteți utiliza spații pentru a separa diferite secțiuni ale formulelor. Apăsați bara de spațiu de mai multe ori pentru a crea o indentare.

Sfârșituri de linie

Împărțiți formulele lungi în mai multe rânduri pentru a le face mai ușor de citit. Apăsați Enter pentru a adăuga o sfârșit de linie în bara de formule.

Utilizați comanda Format text

Comanda „Formatare text” din bara de formule adaugă indentare, spațiere și sfârșituri de linie la codul tău Power Apps . Folosește comanda „Formatare text” pentru a menține un stil de codare consistent în aplicația ta pe pânză și pentru a preveni erorile.

Pasul următor

Optimizarea codului