Leggibilità del codice

La leggibilità del codice è un aspetto importante dello sviluppo di app spesso trascurato. Il codice leggibile è più facile da comprendere, gestire ed eseguire il debug.

Convenzione di denominazione

Le convenzioni di denominazione coerenti migliorano significativamente la leggibilità del codice. Consente di identificare rapidamente lo scopo di ogni elemento nell'app e semplifica l'esplorazione della codebase.

Convenzioni di denominazione generali

Questa sezione descrive le convenzioni di denominazione "CamelCase" e "PascalCase". Se hai già familiarità con questi termini, puoi andare avanti.

Camel case

Utilizzare il "camel case" per i controlli e le variabili. La notazione a cammello inizia con un prefisso minuscolo, rimuove tutti gli spazi nel nome di oggetti o variabili e rende maiuscola la prima lettera di ogni parola dopo la prima. Ad esempio, è possibile assegnare un nome a un controllo di input di testo txtUserEmailAddress.

Caso Pascal

Usare il caso Pascal per le origini dati. La notazione Pascal è talvolta chiamata "notazione upper camel case". Come la notazione camel case, rimuove tutti gli spazi e inizia con la lettera maiuscola di ogni parola. Tuttavia, a differenza della notazione a cammello, la notazione Pascal mette in maiuscolo la prima parola. Ad esempio, un'origine dati comune in Power Apps è il connettore Utenti di Microsoft Office 365, denominato Office365Users nel codice.

Nomi schermo

Scegliere nomi di schermata che mostrano chiaramente lo scopo della schermata, semplificando la navigazione tra app complesse in Power Apps Studio.

I lettori di schermo leggono ad alta voce i nomi degli schermi. Gli utenti con esigenze di accessibilità per la visione si basano su queste utilità per la lettura dello schermo. Usare un linguaggio normale per i nomi dello schermo, includere spazi ed evitare abbreviazioni. Terminare ogni nome con la parola "Screen" per fornire un contesto chiaro quando viene annunciato il nome.

Di seguito sono riportati alcuni esempi:

• Home_Screen o Home Screen
• Search_Screen o Search Screen

Questi nomi degli schermi di esempio sono meno comprensibili:

• Home
• LoaderScreen
• EmpProfDetails
• Thrive Help

Nomi dei controlli

Usare il camel case per tutti i nomi dei controlli nell'area di disegno. Iniziare con un descrittore di tipo a tre caratteri, seguito dallo scopo del controllo. Questo approccio aiuta a identificare il tipo di controllo e semplifica la creazione di formule e la ricerca. Ad esempio, lblUserName indica che il controllo è un'etichetta.

La tabella seguente mostra le abbreviazioni per i controlli comuni.

L'elenco dettagliato dei controlli e delle relative proprietà è descritto in Riferimento ai controlli.

Ecco alcuni esempi negativi:

• zipcode
• Next

Quando dai nomi coerenti ai tuoi controlli, la tua app è più pulita nella visualizzazione di navigazione e anche il tuo codice è più pulito.

Nomi dell'origine dati

Quando si aggiunge un'origine dati all'applicazione, non è possibile modificare il nome nell'app Power Apps. Il nome viene ereditato dal connettore di origine o dalle entità dati derivate dalla connessione.

Di seguito sono riportati alcuni esempi.

• Nome ereditato dal connettore di origine: Il connettore Office 365 Users è denominato Office365Users nel codice.
• Entità di dati derivate dalla connessione: un elenco Microsoft SharePoint denominato Employees viene restituito dal connettore SharePoint. Di conseguenza, il nome dell'origine dati nel codice è Employees. La stessa app Power Apps può anche utilizzare lo stesso connettore SharePoint per accedere a un elenco SharePoint denominato Contractors. In questo caso, il nome dell'origine dati nel codice è Contractors.

Altre informazioni sui connettori e sulle connessioni sono disponibili in Panoramica dei connettori per le app canvas.

Connettori standard di azione

Nei connettori azione standard che espongono funzioni, come LinkedIn, il nome dell'origine dati e le relative operazioni utilizzano la cassa Pascal. Ad esempio, l'origine dati LinkedIn è denominata LinkedIn e ha un'operazione denominata ListCompanies.

ClearCollect(
    colCompanies,
    LinkedIn.ListCompanies()
)

Connettori personalizzati

Usare connettori personalizzati per connettersi alle API (Application Programming Interface) personalizzate, ad esempio servizi o API line-of-business create dall'azienda. Qualsiasi creatore nell'ambiente può creare connettori personalizzati. Usare il Pascal case per il nome dell'origine dati e delle relative operazioni. Il nome del connettore personalizzato e il modo in cui viene visualizzato in Power Apps possono variare.

Considera questo esempio di connettore personalizzato denominato MS Auction Item Bid API.

Quando si crea una connessione da questo connettore e la si aggiunge all'app Power Apps come origine dati, viene visualizzata come AuctionItemBidAPI.

Per individuare il motivo, cercare all'interno del file OpenAPI un attributo title contenente il testo Auction Item Bid API.

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

Power Apps rimuove tutti gli spazi dal valore di questo attributo e lo utilizza come nome della tua origine dati.

Tabelle dati Excel

Power Apps usa dataTable in Microsoft Excel per connettersi ai dati nei fogli di lavoro di Excel. Tieni presente questi punti quando crei documenti Excel come origini dati:

• Dai nomi descrittivi alle tue tabelle dati. Il nome è nell'app Power Apps quando scrivi il codice per connetterti ad essa.
• Utilizzare una tabella dati per il foglio di lavoro.
• Assegna lo stesso nome alla tabella dati e al foglio di lavoro.
• Utilizza nomi di colonna descrittivi nelle tabella dati.
• Utilizzare la convenzione Pascal. Ogni parola del nome DataTable deve iniziare con una lettera maiuscola, ad esempio EmployeeLeaveRequests.

Nomi di variabili

Le convenzioni di denominazione per le variabili nelle app canvas sono importanti per mantenere leggibilità, coerenza e chiarezza nei tuoi progetti Power Apps. Sebbene non venga applicato uno standard rigoroso, l'adozione di una convenzione di denominazione coerente in tutte le app canvas può semplificare la comprensione, l'utilizzo e la gestione delle variabili da parte tua e di altri collaboratori.

• Utilizza la notazione a cammello, dove la prima lettera di ogni parola è in maiuscolo tranne la prima parola.
• Scegli nomi significativi e descrittivi che descrivano chiaramente lo scopo o il contenuto della variabile. Evitare nomi eccessivamente generici come temp o var1. Usare invece nomi descrittivi come userEmail o totalAmount.
• Considera l'utilizzo di prefissi o suffissi per indicare il tipo di variabile. Ad esempio:
  • strUserName per una variabile testo/stringa
  • numTotalAmount per una variabile numerica
  • boolIsEnabled per una variabile booleana
  • locVarName per variabili locali/variabili di contesto
  • gblVarLoginUser per variabili globali
• Decidi se le tue variabili devono essere nominate nella forma singolare o plurale e attieniti a tale convenzione. Ad esempio, usare userCount in modo coerente o users.
• Evita di utilizzare parole o nomi riservati che potrebbero entrare in conflitto con funzioni Power Apps o parole chiave. Controlla la documentazione di Power Apps per un elenco di parole riservate.
• Prendi in considerazione l'utilizzo di prefissi che forniscano il contesto sull'utilizzo o l'ambito della variabile. Ad esempio:
  • frm per le variabili del modulo
  • col per le raccolte
  • var per variabili di uso generale
• Evita caratteri speciali. Mantieni i nomi alfanumerici ed evita caratteri speciali o spazi. Attieniti a lettere e numeri.

Power Apps consente che le variabili di contesto e le variabili globali condividano gli stessi nomi. Questa condivisione può causare confusione perché le formule usano le variabili di contesto per impostazione predefinita, a meno che non si usi l'operatore di disambiguazione.

Evita questa situazione seguendo queste convenzioni:

• Includi un prefisso per le variabili di contesto con loc.
• Includi un prefisso per le variabili globali con gbl.
• Il nome dopo il prefisso deve indicare la finalità o lo scopo della variabile. È possibile usare più parole senza dover separarle in base a caratteri speciali, ad esempio caratteri di sottolineatura, se si maiuscola la prima lettera di ogni parola.
• Usa camel case. Inizia i nomi delle variabili con un prefisso in lettere minuscole, quindi scrivi in ​​maiuscolo la prima lettera di ogni parola nel nome.

Questi esempi seguono standard e convenzioni:

• Variabile globale:gblFocusedBorderColor
• Variabile di contesto:locSuccessMessage
• Variabile di ambito:scpRadius

Questi esempi non seguono gli standard e sono più difficili da capire:

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

Evitare nomi brevi e criptici di variabili, ad EIDesempio . Utilizzare invece EmployeeId.

Quando un'app ha molte variabili, digitare il prefisso nella barra della formula per visualizzare un elenco di variabili disponibili. Se si seguono queste linee guida per denominare le variabili, è possibile trovarle facilmente nella barra della formula durante lo sviluppo dell'app. In definitiva, questo approccio porta allo sviluppo di app più veloce ed efficiente.

Nomi delle raccolte

• Usare nomi che descrivono il contenuto della raccolta. Considerare cosa contiene la raccolta e come viene usata e denominarla di conseguenza.
• Prefissi i nomi delle raccolte con col.
• Usare il nome dopo il prefisso per visualizzare la finalità o lo scopo della raccolta. È possibile usare più parole senza spazi o caratteri di sottolineatura se si maiuscola la prima lettera di ogni parola.
• Usa il CamelCase. Avvia i nomi della raccolta con un prefisso minuscolo col, e poi scrivi in maiuscolo la prima lettera di ogni parola nel nome.

Questi esempi seguono le convenzioni sui nomi delle raccolte:

• colMenuItems
• colThriveApps

Questi esempi non seguono le convenzioni sui nomi delle raccolte:

• orderscoll
• tempCollection

Commenti e documentazione

Quando scrivi codice per la tua applicazione, concentrati sull'aggiunta di commenti chiari. I commenti consentono di comprendere il codice in un secondo momento e di semplificare il lavoro dello sviluppatore successivo nel progetto.

Power Apps supporta due stili di commenti per rendere il codice più chiaro: i commenti di riga, che utilizzano le doppie barre (//) per le note a riga singola e i commenti a blocco, che utilizzano /* e */ per le note su più righe.

Commenti in riga

Aggiungi un doppio slash (//) a qualsiasi riga di codice in Power Apps per trasformare il resto della riga in un commento.

Usa i commenti di riga per spiegare cosa fa la riga di codice successiva. Puoi anche usarli per disabilitare temporaneamente una riga di codice per il test.

Ecco un esempio di commento di riga.

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

Blocca i commenti

Il testo tra /* e */ è un commento di blocco. I commenti di blocco possono coprire più righe, a differenza dei commenti di riga, che coprono solo una riga.

Usa i commenti di blocco per spiegazioni più lunghe, ad esempio per documentare l'intestazione di un modulo di codice. È inoltre possibile utilizzarli per disabilitare temporaneamente diverse righe di codice durante il test o il debug.

Per una migliore organizzazione del codice, aggiungere commenti dopo aver utilizzato la funzionalità Formato testo. Questo approccio consente di visualizzare i commenti prima di un blocco di codice.

/*
    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 funzione Formato testo segue le seguenti regole per i commenti:

1. Se una proprietà inizia con un commento di blocco, viene aggiunta la riga di codice successiva.
2. Se una proprietà inizia con un commento di riga, la riga di codice successiva non viene aggiunta. Altrimenti il ​​codice viene commentato.
3. In altre parti della proprietà, i commenti di riga e di blocco vengono aggiunti alla riga di codice precedente.

Non preoccuparti di aggiungere troppi commenti o commenti troppo lunghi. Power Apps rimuove tutti i commenti quando crea il pacchetto dell'app client. I commenti non influiscono sulle dimensioni del pacchetto, sulla velocità di download dell'app o sui tempi di caricamento.

Designer di app moderno con commenti

In Power Apps, utilizza le funzionalità di commento sia in Power Apps Studio che nel designer di app moderno.

Per aggiungere commenti in Power Apps Studio, usa questi metodi:

• Fare clic con il pulsante destro del mouse sulle ellissi ("...") di qualsiasi elemento nella vista ad albero.
• Fai clic con il pulsante destro del mouse su un componente nell'area della canvas.
• Selezionare il pulsante Commenti che si trova sulla barra dei comandi nell'angolo superiore destro della schermata.

Quando menzioni un collega in un commento, usa il simbolo "@" seguito dal suo nome. Questa azione invia un messaggio di posta elettronica di notifica alla persona contrassegnata. Se l'utente taggato non ha accesso all'app, Power Apps ti chiede di condividere l'app.

Identificazione e formattazione

Il rientro e la formattazione consentono di mantenere chiara e organizzata l'app. Quando il codice è ben formattato, è più facile leggere e comprendere.

Indentazione

Power Apps non impone un rientro rigoroso. Usare gli spazi per separare diverse sezioni delle formule. Premere più volte la barra spaziatrice per creare un'indentazione.

Interruzioni di riga

Suddividi le formule lunghe in più righe per renderle più facili da leggere. Premere INVIO per aggiungere un'interruzione di riga nella barra della formula.

Utilizza il comando Formatta testo

Il comando Formatta testo nella barra delle formule aggiunge rientro, spaziatura e interruzioni di riga al codice di Power Apps. Usare il comando Formatta testo per mantenere uno stile di codifica coerente nell'app canvas e per evitare errori.

Informazioni pertinenti

• Usare convenzioni di denominazione coerenti nei flussi cloud di Power Automate
• Creare script leggibili e gestibili nei flussi desktop di Power Automate

Passaggio successivo