Comparteix a través de

Legibilitat del codi

Convencions de nomenclatura

Convencions generals de nomenclatura

Aquesta secció descriu les convencions de nomenclatura "camel case" i "Pascal case". Si ja esteu familiaritzat amb aquests termes, podeu avançar.

Camel case

Heu d'utilitzar camel case per als controls i les variables. Les majúscules i minúscules comencen amb un prefix en minúscules, eliminen tots els espais dels noms d'objectes o variables i posen en majúscula la primera lletra de cada paraula després de la primera. Per exemple, un control d'entrada de text pot anomenar-se txtUserEmailAddress.

Pascal case

Hauríeu d'utilitzar Pascal case per a les fonts de dades. El cas Pascal de vegades es coneix com a "cas del camell superior". Com la caixa del camell, elimina tots els espais i posa en majúscula la primera lletra de les paraules. No obstant això, a diferència de camel case, Pascal case també escriu en majúscula la primera paraula. Per exemple, una font de dades comuna és PowerApps el connector Usuaris del Microsoft Office 365, que s'anomena Office365Users al vostre codi.

Noms de pantalla

Els noms de pantalla han de reflectir el propòsit de la pantalla, de manera que sigui més fàcil navegar per aplicacions complexes Power Apps Studio.

El que és menys obvi és que els noms de pantalla són llegits en veu alta pels lectors de pantalla, que són necessaris per als usuaris que tenen necessitats d'accessibilitat visual. Per tant, és imprescindible que utilitzeu un llenguatge senzill per anomenar les pantalles i que els noms incloguin espais i sense abreviatures. A més, us recomanem que acabeu el nom amb la paraula "Pantalla", de manera que s'entengui el context quan s'anunciï el nom.

Aquí teniu alguns bons exemples:

  • Home_Screen o Home Screen
  • Search_Screen o Search Screen

Captura de pantalla que mostra una llista de noms de pantalla que segueixen el patró descrit

Aquests noms de pantalla d'exemple són menys comprensibles:

  • Home
  • LoaderScreen
  • EmpProfDetails
  • Thrive Help

Noms dels controls

Tots els noms de control del llenç han d'utilitzar camel case. Haurien de començar amb un descriptor de tipus de tres caràcters, seguit del propòsit de control. Aquest enfocament ajuda a identificar el tipus de control i facilita la creació de fórmules i la cerca. Per exemple, lblUserName indica que el control és una etiqueta.

La taula següent mostra les abreviatures dels controls comuns.

Nom del control Abreviatura
Distintiu BDG
Button btn
Control de la càmera lleva
Llenç llauna
Card crd
Gràfics Chr
Casella de selecció chk
Col·lecció col
Combo box CMB
Component CMP
Contenidor contra
Dates dte
Desplegable DRP
Formulari frm
Galeria gal
Agrupa PRFV
Capçalera Hdr
Text HTML htm
Icon ico
Image img
Botó d'informació info
Label Lbl
Enllaç lnk
List box Lst
Micròfon Mic
Microsoft Stream Str
Forma de la secció de la pàgina s
Entrada de llapis bolígraf
Peça del Power BI PBI
Barra de progrés pbar
Nivell d’interès rtg
Editor de text enriquit Rte
Formes (rectangle, cercle, etc.) Shp
Control lliscant Sld
Llista de fitxes TBL
Table TBL
Text input txt
Temporitzador Tmr
Opció TGL
Video Vídeo

La llista detallada dels controls i les seves propietats es descriu a Referència de controls.

Nota

Els noms de control han de ser únics en una aplicació. Si un control es reutilitza en diverses pantalles, el nom de pantalla curt hauria de tenir un sufix. Per exemple, galBottomNavMenuHS on "HS" significa "Pantalla d'inici". Aquest enfocament facilita la referència al control en fórmules entre pantalles.

Aquí hi ha alguns mals exemples:

  • zipcode
  • Next

Quan anomeneu els controls de manera coherent, l'aplicació és més neta a la visualització de navegació i el codi també és més net.

Captura de pantalla de la vista de navegació que mostra els noms dels controls seguint el patró

Noms de fonts de dades

Quan afegiu una font de dades a l'aplicació, el nom no es pot canviar a l'aplicació Power Apps . El nom s'hereta del connector d'origen o de les entitats de dades derivades de la connexió.

A continuació trobareu alguns exemples:

  • Nom heretat del connector d'origen: El Office 365 connector d'usuaris s'anomena Office365Users al vostre codi.
  • Entitats de dades derivades de la connexió: Es retorna una llista de Microsoft SharePoint anomenada Employees des del SharePoint connector. Per tant, el nom de la font de dades del codi és Empleats. La mateixa Power Apps aplicació també pot utilitzar el mateix SharePoint connector per accedir a una SharePoint llista anomenada Contractors. En aquest cas, el nom de la font de dades del codi és Contractors.

Per obtenir més informació sobre connectors i connexions, vegeu Visió general dels connectors d'aplicacions de llenç per Power Apps.

Connectors d'acció estàndard

En els connectors d'acció estàndard que exposen funcions, com ara LinkedIn, el nom font de dades i les seves operacions utilitzen Pascal case. Per exemple, la font de dades de LinkedIn s'anomena LinkedIn i té una operació anomenada ListCompanies.

ClearCollect(
    colCompanies,
    LinkedIn.ListCompanies()
)

Connectors personalitzats

Connectors personalitzats que s'utilitzen per connectar-se a interfícies de programació d'aplicacions (API) personalitzades, com ara serveis o API de línia de negoci que ha creat la vostra empresa. Poden ser creats per qualsevol fabricant del vostre entorn. Recomanem Pascal case per al nom font de dades i el seu funcionament. Tingueu en compte que el nom del connector personalitzat i la forma en què apareix PowerApps poden variar.

Considereu aquest exemple d'un connector personalitzat anomenat MS Auction Item Bid API.

Captura de pantalla d'un connector anomenat MS Auction Item Bid API

Però quan creeu una connexió des d'aquest connector i l'afegiu a l'aplicació PowerApps com a font de dades, apareix com AuctionItemBidAPI.

Captura de pantalla d'un connector que mostra que el nom és AuctionItemBidAPI

Per descobrir el motiu, podeu buscar dins del OpenAPI fitxer un atribut title que contingui el text Auction Item Bid API.

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

Power Apps suprimeix tots els espais d'aquest valor d'atribut i l'utilitza com a nom de la font de dades.

Propina

Us recomanem que canvieu el valor d'aquest atribut per un nom amb majúscules i minúscules en Pascal, com ara AuctionItemBidAPI , i que l'utilitzeu com a nom de la vostra connexió personalitzada. D'aquesta manera, no hi haurà confusió. Canvieu aquest valor abans d'importar el fitxer OpenAPI per crear el connector personalitzat.

Nota

Si feu servir l'opció Crea des d'un fitxer en blanc en comptes d'importar un fitxer OpenAPI existent, PowerApps us demanarà el nom del connector personalitzat. Aquest nom s'utilitzarà tant com a nom del connector personalitzat com a valor de l'atribut title dins del fitxer OpenAPI . Assegureu-vos d'utilitzar un nom amb majúscules i minúscules en Pascal, com ara AuctionItemBidAPI , per mantenir la coherència i la simplicitat.

Taules de dades d'Excel

PowerApps utilitza DataTables a Microsoft Excel per connectar-se a dades de fulls de càlcul d'Excel. Tingueu en compte aquests punts quan creeu documents d'Excel com a fonts de dades:

  • Doneu noms descriptius a les vostres DataTables. El nom és a l'aplicació quan escrius el codi per connectar-t'hi. Power Apps
  • Utilitzeu una taula de dades per full de càlcul.
  • Doneu el mateix nom a la taula de dades i al full de càlcul.
  • Utilitzeu noms de columna descriptius a les DataTables.
  • Utilitzeu Pascal case. Cada paraula del nom de la taula de dades ha de començar amb una lletra majúscula, com ara EmployeeLeaveRequests.

Objectes dinàmics i sense tipus

Noms de variables

Les convencions de nomenclatura per a les variables a les aplicacions de llenç són importants per mantenir la llegibilitat, la coherència i la claredat als vostres projectes. Power Apps Tot i que no s'aplica cap estàndard estricte, l'adopció d'una convenció de nomenclatura coherent a tota l'aplicació de llenç pot facilitar que a vosaltres i a altres col·laboradors us entengueu, utilitzeu i gestioneu les variables.

  • Utilitzeu la majúscula de camel, on la primera lletra de cada paraula es posa en majúscula excepte la primera paraula.
  • Trieu noms significatius i descriptius que descriguin clarament la finalitat o el contingut de la variable. Eviteu noms massa genèrics com ara temp o var1. En comptes d'això, feu servir noms descriptius com ara userEmail o totalAmount.
  • Considereu l'ús de prefixos o sufixos per indicar el tipus de variable. Per exemple:
    • strUserName per a una variable de text/cadena
    • numTotalAmount per a una variable numèrica
    • boolIsEnabled per a una variable booleana
    • locVarName per a variables locals/variables de context
    • gblVarLoginUser per a variables globals
  • Decideix si les variables s'han de nomenar en singular o plural i segueix aquesta convenció. Per exemple, feu servir de manera consistent userCount o users.
  • Eviteu utilitzar paraules o noms reservats que puguin entrar en conflicte amb funcions o paraules clau. Power Apps Consulteu la Power Apps documentació per obtenir una llista de paraules reservades.
  • Considereu l'ús de prefixos que proporcionin context sobre l'ús o l'abast de la variable. Per exemple:
    • frm per a variables de formulari
    • col per a col·leccions
    • var per a variables d'ús general
  • Eviteu els caràcters especials. Mantingueu els noms alfanumèrics i eviteu els caràcters especials o els espais. Fixeu-vos en les lletres i els números.

Power Apps que les variables de context i les variables globals comparteixin els mateixos noms. Això pot causar confusió perquè les fórmules utilitzen variables de context per defecte, tret que s'utilitzi l'operador de desambiguació .

Eviteu aquesta situació seguint aquestes convencions:

  • Prefixeu les variables de context amb loc.
  • Prefixeu les variables globals amb gbl.
  • El nom després del prefix ha d'indicar la intenció/propòsit de la variable. Es poden utilitzar diverses paraules i no cal separar-les per caràcters especials, com ara espais o subratllats, si la primera lletra de cada paraula va en majúscula.
  • Utilitzeu camel case. Comenceu els noms de les variables amb un prefix en minúscula i, a continuació, escriviu en majúscula la primera lletra de cada paraula del nom.

Aquests exemples segueixen estàndards i convencions:

  • Variable global:gblFocusedBorderColor

  • Variable de context:locSuccessMessage

  • Variable d'abast:scpRadius

Aquests exemples no segueixen els estàndards i són més difícils d'entendre:

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

Eviteu noms de variables curts i críptics com ara EID. Use EmployeeId en canvi.

Quan hi ha moltes variables en una aplicació, només cal que escriviu el prefix a la barra de fórmules per veure una llista de les variables disponibles. Si seguiu aquestes pautes per anomenar les variables, les podreu trobar fàcilment a la barra de fórmules a mesura que desenvolupeu l'aplicació. En definitiva, aquest mètode permet un desenvolupament d'aplicacions més ràpid.

Noms de col·leccions

  • Sigues descriptiu del contingut de la col·lecció. Pensa en què conté la col·lecció i/o com s'utilitza i, a continuació, posa-li un nom en conseqüència.
  • Les col·leccions han de tenir com a prefix col.
  • El nom que va després del prefix ha d'indicar la intenció o la finalitat de la col·lecció. Es poden utilitzar diverses paraules i no cal separar-les per espais o subratllats, si la primera lletra de cada paraula va en majúscula.
  • Utilitzeu camel case. Comenceu els noms de les vostres col·leccions amb el prefix "col" en minúscula i, a continuació, escriviu en majúscula la primera lletra de cada paraula del nom.

Aquests exemples segueixen les convencions de noms de col·lecció:

  • colMenuItems
  • colThriveApps

Aquests exemples no segueixen les convencions de noms de col·leccions:

  • orderscoll
  • tempCollection

Propina

Quan hi ha moltes col·leccions a l'aplicació, només cal que escriviu el prefix a la barra de fórmules per veure una llista de les col·leccions disponibles. Pel que fa a les variables, si seguiu aquestes pautes per anomenar les vostres col·leccions, les podreu trobar molt fàcilment a la barra de fórmules a mesura que desenvolupeu l'aplicació. En definitiva, aquest mètode permet un desenvolupament d'aplicacions més ràpid.

Comentaris i documentació

A mesura que escriviu el codi per a la vostra aplicació, emfatitzeu la importància de fer comentaris complets. Aquests comentaris no només serveixen com a guia útil quan torneu a visitar l'aplicació mesos després, sinó que també són un gest de gratitud al següent desenvolupador que col·labori en el projecte.

Hi ha dos tipus principals de comentaris per millorar la claredat del codi: Power Apps admet dos estils de comentari: comentaris de línia, denotats per barres inclinades dobles (//) per a comentaris d'una sola línia, i comentaris de bloc tancats dins /* i */ per a anotacions de diverses línies.

Comentaris de línia

Afegir una doble barra inclinada (//) a qualsevol línia de codi designa PowerApps la resta de la línia (incloent-hi la //) com a comentari.

Utilitzeu comentaris de línia per dilucidar la funcionalitat del codi següent. També poden servir per desactivar temporalment una línia de codi, fent-los beneficiosos per a les proves.

Aquest exemple mostra l'ús de comentaris de línia.

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

Bloquejar comentaris

Text tancat dins /* i */ es reconeix com a comentari de bloc. A diferència dels comentaris de línia que s'apliquen a una sola línia, els comentaris de bloc poden abastar diverses línies.

Els comentaris de bloc són útils per a explicacions de diverses línies, com ara documentar una capçalera de mòdul de codi. També faciliten la desactivació temporal de diverses línies de codi durant les proves o la depuració.

Per a una organització òptima del codi, és recomanable afegir comentaris després d'utilitzar la funció Format de text. Això és beneficiós si els vostres comentaris precedeixen un bloc de codi.

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

La funció Format de text segueix aquestes regles per als comentaris existents:

  1. Si una propietat comença amb un comentari de bloc, s'hi afegirà la següent línia de codi.
  2. Si una propietat comença amb un comentari de línia, no s'hi afegirà la següent línia de codi. En cas contrari, el codi es comenta.
  3. Els comentaris de línia i bloc en altres llocs de la propietat s'afegiran a la línia de codi anterior.

No us preocupeu per afegir massa comentaris o comentaris massa llargs. Tots els comentaris s'eliminen quan PowerApps es crea el paquet de l'aplicació client. Per tant, no afectaran la mida del paquet ni alentiran els temps de descàrrega o càrrega de l'aplicació.

Dissenyador d'aplicacions modern amb comentaris

A més Power Apps, es considera la millor pràctica per als creadors utilitzar eficaçment les funcions de comentaris tant dins del Power Apps Studio dissenyador d'aplicacions modern.

Per a una participació òptima Power Apps Studio, es recomana als creadors que afegeixin comentaris mitjançant els mètodes següents:

  1. Feu clic amb el botó dret a les punts suspensius ("...") de qualsevol element de la vista d'arbre.
  2. Feu clic amb el botó dret en un component de l'àrea del llenç.
  3. Seleccioneu el botó "Comentaris" situat a la barra d'ordres a l'extrem superior dret de la pantalla.

Quan esmenteu els companys als comentaris, es recomana utilitzar el símbol "@" seguit del seu nom. Això demana un correu electrònic de notificació per al company etiquetat, garantint un accés ràpid al comentari. En els casos en què un usuari etiquetat no tingui accés a l'aplicació, se li demana al creador que comparteixi l'aplicació amb ell.

Una captura de pantalla d'una aplicació de despeses que mostra una persona @ esmentada al comentari

Sagnat i format

El Power Apps sagnat i el format són crucials per mantenir una estructura clara i organitzada a l'aplicació. Seguir les pràctiques recomanades millora la llegibilitat de les fórmules i els controls.

Barra de fórmules

Sagnia

Tot i que Power Apps no aplica un sagnat estricte, podeu utilitzar espais per separar visualment diferents seccions de les fórmules. Premeu la barra espaiadora diverses vegades per crear un efecte de sagnat.

Salts de línia

Podeu dividir fórmules llargues en diverses línies per millorar la llegibilitat. Premeu Retorn per crear un salt de línia dins de la barra de fórmules.

Utilitzar l'ordre Format de text

L'ordre "Formata el text" de la barra de fórmules està dissenyada per aplicar sagnat, espaiat i salts de línia al codi Power Apps . Utilitzeu l'ordre "Format de text" per establir un estil de codificació uniforme a tota l'aplicació de llenç, garantint un procés de desenvolupament més eficient i resistent als errors.

Captura de pantalla de l'estudi Power Apps amb l'ordre Format de text ressaltada

Pas següent

Optimització de codi