Lisibilité du code

Conventions de dénomination

Conventions de dénomination générales

Cette section décrit les conventions de dénomination « casse chameau » et « casse Pascal ». Si vous connaissez déjà ces termes, vous pouvez passer à la section suivante.

Casse chameau

Vous devez utiliser la casse chameau pour les contrôles et les variables. La casse chameau commence par un préfixe en minuscule, supprime tous les espaces des noms d’objets ou de variables et met en majuscule la première lettre de chaque mot après le premier. Par exemple, un contrôle de saisie de texte peut être nommé txtUserEmailAddress.

Casse Pascal

Vous devez utiliser la casse Pascal pour les sources de données. Le cas Pascal est parfois appelé « cas chameau supérieur ». Comme le camel case, il supprime tous les espaces et met une majuscule à la première lettre des mots. Cependant, contrairement à la casse chameau, la casse Pascal met également en majuscule le premier mot. Par exemple, une source de données courante dans PowerApps est le connecteur Utilisateurs Microsoft Office 365, qui est nommé Office365Users dans votre code.

Noms d’écran

Les noms d’écran doivent refléter l’objectif de l’écran, afin qu’il soit plus facile de naviguer dans des applications complexes dans Power Apps Studio.

Ce qui est moins évident, c’est que les noms d’écran sont lus à haute voix par des lecteurs d’écran, qui sont nécessaires pour les utilisateurs ayant des besoins en matière d’accessibilité visuelle. Par conséquent, il est impératif que vous utilisiez un langage simple pour nommer vos écrans et que les noms incluent des espaces et aucune abréviation. Nous vous recommandons également de terminer le nom par le mot « Écran », afin que le contexte soit compris lorsque le nom est annoncé.

Voici quelques exemples pertinents :

• Home_Screen ou Home Screen
• Search_Screen ou Search Screen

Ces exemples de noms d’écran sont moins compréhensibles :

• Home
• LoaderScreen
• EmpProfDetails
• Thrive Help

Noms de contrôles

Tous les noms de contrôle sur le canevas doivent utiliser la casse chameau. Ils doivent commencer par un descripteur de type à trois caractères, suivi de l’objectif du contrôle. Cette approche permet d’identifier le type de contrôle et facilite la création de formules et la recherche. Par exemple, lblUserName indique que le contrôle est une étiquette.

Le tableau suivant présente les abréviations des contrôles courants.

Nom du contrôle	Abréviation
Badge	bdg
Bouton	btn
Contrôle Caméra	cam
Canevas	can
Carte	crd
Graphiques	chr
Case à cocher	chk
Collection	col
Zone de liste déroulante	cmb
Composant	cmp
Conteneur	con
Dates	dte
Liste déroulante	drp
Formulaire	frm
Galerie	gal
Groupe	grp
En-tête	hdr
Texte html	htm
Icône	ico
Image	img
Bouton d’informations	Informations
Étiquette	lbl
Lien	lnk
Zone de liste	lst
Microphone	mic
Microsoft Stream	str
Forme d’une section de page	sec
Saisie effectuée à l’aide du stylet	pen
Vignette Power BI	pbi
Barre de progression	pbar
Classement	rtg
Éditeur de texte enrichi	rte
Formes (rectangle, cercle, etc.)	shp
Curseur	sld
Liste d’onglets	tbl
Table	tbl
Saisie de texte	txt
Minuteur	tmr
Bouton à bascule	tgl
Vidéo	vid

La liste détaillée des contrôles et de leurs propriétés est décrite dans Référence des contrôles.

Nonte

Les noms de contrôle doivent être uniques dans une application. Si un contrôle est réutilisé sur plusieurs écrans, le nom abrégé de l’écran doit avoir un suffixe. Par exemple, galBottomNavMenuHS, où « HS » signifie « Écran d’accueil ». Cette approche facilite la référence au contrôle dans les formules entre les écrans.

Voici quelques exemples incorrects :

• zipcode
• Next

Lorsque vous nommez de manière cohérente vos contrôles, votre application est plus propre dans la vue de navigation, tout comme votre code.

Noms de la source de données

Lorsque vous ajoutez une source de données à votre application, le nom ne peut pas être modifié dans l’application Power Apps. Le nom est hérité du connecteur source ou des entités de données dérivées de la connexion.

En voici quelques exemples :

• Nom hérité du connecteur source : le connecteur Utilisateurs Office 365 est namedOffice365Users dans votre code.
• Entités de données dérivées de la connexion : une liste Microsoft SharePoint nommée Employees est renvoyée par le connecteur SharePoint. Par conséquent, le nom de la source de données dans votre code est Employés. La même application Power Apps peut également utiliser le même connecteur SharePoint pour accéder à une liste SharePoint nommée Contractors. Dans ce cas, le nom de la source de données dans le code est Contractors.

Pour plus d’informations sur les connecteurs et les connexions, consultez Présentation des connecteurs d’application canevas pour Power Apps.

Connecteurs d’action standard

Dans les connecteurs d’action standard qui exposent des fonctions, telles que LinkedIn, le nom de la source de données et ses opérations utilisent la casse Pascal. Par exemple, la source de données LinkedIn est nommée LinkedIn et contient une opération nommée ListCompanies.

ClearCollect(
    colCompanies,
    LinkedIn.ListCompanies()
)

Connecteurs personnalisés

Connecteurs personnalisés utilisés pour se connecter aux interfaces de programmation d’applications (API) personnalisées telles que des services ou des API métier créés par votre entreprise. Ils peuvent être créés par n’importe quel créateur dans votre environnement. Nous recommandons la casse Pascal pour le nom de la source de données et ses opérations. Tenez compte du fait que le nom du connecteur personnalisé et la façon dont il apparaît dans PowerApps peuvent différer.

Prenons cet exemple d’un connecteur personnalisé nommé MS Auction Item Bid API.

Mais lorsque vous créez une connexion à partir de ce connecteur et que vous l’ajoutez à votre application PowerApps en tant que source de données, il apparaît comme AuctionItemBidAPI.

Pour découvrir la raison, vous pouvez rechercher dans le fichier OpenAPI un attribut de titre contenant le texte Auction Item Bid API.

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

Power Apps supprime tous les espaces de cette valeur d’attribut et l’utilise comme nom de votre source de données.

Astuce

Nous vous recommandons de modifier la valeur de cet attribut par un nom en casse Pascal tel que AuctionItemBidAPI et de l’utiliser comme nom de votre connexion personnalisée. De cette façon, il n’y aura aucune confusion. Modifiez cette valeur avant d’importer le fichier OpenAPI pour créer le connecteur personnalisé.

Nonte

Si vous utilisez l’option Créer à partir d’un fichier vide au lieu d’importer un fichier OpenAPI existant, PowerApps vous demandera le nom du connecteur personnalisé. Ce nom sera utilisé à la fois comme nom du connecteur personnalisé et comme valeur de l’attribut de titre dans le fichier OpenAPI. Assurez-vous d’utiliser un nom en casse Pascal tel que AuctionItemBidAPI pour que les choses restent cohérentes et simples.

Tables de données Excel

PowerApps utilise des tables de données dans Microsoft Excel pour se connecter aux données dans des feuilles de calcul Excel. Gardez ces points à l’esprit lorsque vous créez des documents Excel comme sources de données :

• Donnez des noms descriptifs à vos tables de données. Le nom se trouve dans l’application Power Apps lorsque vous écrivez le code pour vous y connecter.
• Utilisez une table de données par feuille de calcul.
• Donnez le même nom à la table de données et à la feuille de calcul.
• Utilisez des noms de colonne descriptifs dans les tables de données.
• Utilisez la casse Pascal. Chaque mot du nom Table de données doit commencer par une lettre majuscule, telle que EmployeeLeaveRequests.

Noms de variable

Les conventions de dénomination des variables dans les applications canevas sont importantes pour maintenir la lisibilité, la cohérence et la clarté de vos projets Power Apps. Bien qu’aucune norme stricte ne soit appliquée, l’adoption d’une convention d’affectation de noms cohérente dans votre application canevas peut vous permettre, ainsi qu’à d’autres collaborateurs, de comprendre, d’utiliser et de gérer plus facilement les variables.

• Utilisez la casse chameau, où la première lettre de chaque mot est en majuscule, à l’exception du premier mot.
• Choisissez des noms significatifs et descriptifs qui décrivent clairement l’objectif ou le contenu de la variable. Évitez les noms trop génériques comme temp ou var1. À la place, utilisez des noms descriptifs comme userEmail ou totalAmount.
• Pensez à utiliser des préfixes ou des suffixes pour indiquer le type de variable. Par exemple :
  • strUserName pour une variable de texte/chaîne
  • numTotalAmount pour une variable numérique
  • boolIsEnabled pour une variable booléenne
  • locVarName pour les variables locales/variables de contexte
  • gblVarLoginUser pour les variables globales
• Décidez si vos variables doivent être nommées à la forme singulière ou plurielle et respectez cette convention. Par exemple, utilisez de manière cohérente userCount ou users.
• Évitez d’utiliser des mots ou noms réservés qui pourraient entrer en conflit avec des fonctions ou mots-clés Power Apps. Consultez la documentation Power Apps pour obtenir une liste de mots réservés.
• Pensez à utiliser des préfixes qui fournissent un contexte sur l’utilisation ou la portée de la variable. Par exemple :
  • frm pour les variables de formulaire
  • col pour les collections
  • var pour les variables à usage général
• Évitez les caractères spéciaux. Maintenez les noms alphanumériques et évitez les caractères spéciaux ou les espaces. Limitez-vous aux lettres et nombres.

Power Apps permet aux variables de contexte et aux variables globales de partager les mêmes noms. Cela peut prêter à confusion, car vos formules utilisent des variables de contexte par défaut, sauf si l’opérateur de désambiguïsation est utilisé.

Évitez cette situation en suivant ces conventions :

• Ajoutez le préfixe loc aux variables de contexte.
• Ajoutez le préfixe gbl aux variables globales.
• Le nom après le préfixe doit indiquer l’intention ou l’objectif de la variable. Plusieurs mots peuvent être utilisés et ne doivent pas nécessairement être séparés par des caractères spéciaux, tels que des espaces ou des traits de soulignement, si la première lettre de chaque mot est en majuscule.
• Utilisez la casse chameau. Commencez vos noms de variable par un préfixe en lettres minuscules, puis mettez en majuscule la première lettre de chaque mot du nom.

Ces exemples suivent les normes et les conventions :

• Variable globale : gblFocusedBorderColor

• Variable de contexte : locSuccessMessage

• Variable d’étendue : scpRadius

Ces exemples ne respectent pas les normes et sont plus difficiles à comprendre :

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

Évitez les noms de variable courts et énigmatiques tels que EID. Use EmployeeId à la place.

Lorsqu’une application contient de nombreuses variables, vous pouvez simplement saisir le préfixe dans la barre de formule pour voir une liste des variables disponibles. Si vous suivez ces instructions pour nommer vos variables, vous pouvez les retrouver facilement dans la barre de formule au fur et à mesure que vous développez votre application. Au final, cette approche aboutit à un développement d’applications plus rapide.

Noms de collection

• Décrivez le contenu de la collection. Réfléchissez à ce que contient la collection et/ou à la manière dont elle est utilisée, puis nommez-la en conséquence.
• Les collections doivent avoir le préfixe col.
• Le nom après le préfixe doit indiquer l’intention ou l’objectif de la collection. Plusieurs mots peuvent être utilisés et ne doivent pas nécessairement être séparés par des espaces ou des traits de soulignement, si la première lettre de chaque mot est en majuscule.
• Utilisez la casse chameau. Commencez vos noms de collection par un préfixe col en minuscule, puis mettez en majuscule la première lettre de chaque mot du nom.

Ces exemples suivent les conventions pou les noms de collection :

• colMenuItems
• colThriveApps

Ces exemples ne suivent pas les conventions pour les noms de collection :

• orderscoll
• tempCollection

Astuce

Lorsque l’application contient de nombreuses collections, vous pouvez simplement saisir le préfixe dans la barre de formule pour voir une liste des collections disponibles. En ce qui concerne les variables, si vous suivez ces instructions pour nommer vos collections, vous pourrez les trouver facilement dans la barre de formule au fur et à mesure que vous développerez votre application. Au final, cette approche aboutit à un développement d’applications plus rapide.

Commentaires et documentation

Lorsque vous écrivez du code pour votre application, concentrez-vous sur l’ajout de commentaires clairs. Les commentaires vous aident à comprendre votre code par la suite et facilitent le travail du prochain développeur sur le projet.

Power Apps prend en charge deux styles de commentaires pour rendre votre code plus clair : les commentaires de ligne, qui utilisent des barres obliques doubles (//) pour les notes sur une seule ligne, et les commentaires de bloc, qui utilisent /* et */ pour les notes sur plusieurs lignes.

Commentaires de ligne

Ajoutez une double barre oblique (//) à n’importe quelle ligne de code dans Power Apps pour convertir le reste de la ligne en commentaire.

Utilisez les commentaires de ligne pour expliquer ce que fait la ligne de code suivante. Vous pouvez également les utiliser pour désactiver temporairement une ligne de code à des fins de test.

Voici un exemple de commentaire de ligne.

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

Commentaires de bloc

Le texte entre /* et */ est un commentaire de bloc. Les commentaires de bloc peuvent couvrir plusieurs lignes, contrairement aux commentaires de ligne, qui ne couvrent qu’une seule ligne.

Utilisez les commentaires de bloc pour des explications plus longues, comme la documentation d’un en-tête de module de code. Vous pouvez également les utiliser pour désactiver temporairement plusieurs lignes de code pendant les tests ou le débogage.

Pour une meilleure organisation du code, ajoutez des commentaires après avoir utilisé la fonctionnalité de mise en forme du texte. Cela est utile si vos commentaires précèdent un bloc de code.

/*
    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 fonctionnalité de mise en forme du texte suit les règles suivantes pour les commentaires :

1. Si une propriété commence par un commentaire de bloc, la ligne de code suivante lui est ajoutée.
2. Si une propriété commence par un commentaire de ligne, la ligne de code suivante n’y est pas ajoutée. Sinon, le code est commenté.
3. Les commentaires de ligne et de bloc ailleurs dans la propriété sont ajoutés à la ligne de code précédente.

Ne vous inquiétez pas d’ajouter trop de commentaires ou trop longs. Power Apps supprime tous les commentaires lors de la création du package d’application cliente, par conséquent, les commentaires n’affectent pas la taille du package ni ne ralentissent les téléchargements de l’application ou les temps de chargement.

Concepteur d’applications moderne avec commentaires

Dans Power Apps, il est préférable d’utiliser les fonctionnalités de commentaire à la fois dans Power Apps Studio et le concepteur d’applications moderne.

Pour ajouter des commentaires dans Power Apps Studio, utilisez ces méthodes :

1. Cliquez avec le bouton droit sur les points de suspension (« ... ») de n’importe quel élément dans l’arborescence.
2. Cliquez avec le bouton droit sur un composant dans la zone du canevas.
3. Sélectionnez le bouton « Commentaires » situé sur la barre de commande dans le coin supérieur droit de l’écran.

Lorsque vous mentionnez un collègue dans un commentaire, utilisez le symbole « @ » suivi de son nom. Cela envoie un e-mail de notification à la personne que vous indiquez. Si l’utilisateur indiqué n’a pas accès à l’application, Power Apps vous invite à partager l’application avec lui.

Mise en retrait et mise en forme

Dans Power Apps, la mise en retrait et la mise en forme permettent de maintenir votre application claire et organisée. En suivant les meilleures pratiques, vos formules et vos contrôles sont plus faciles à lire.

Barre de formule

Mise en retrait

Power Apps n’applique pas de mise en retrait stricte, mais vous pouvez utiliser des espaces pour séparer différentes sections de vos formules. Appuyez plusieurs fois sur la barre d’espace pour créer une indentation.

Sauts de ligne

Divisez les formules longues en plusieurs lignes pour les rendre plus faciles à lire. Appuyez sur Entrée pour ajouter un saut de ligne dans la barre de formule.

Utiliser la commande Formater le texte

La commande « Mettre en forme le texte » dans la barre de formule ajoute la mise en retrait, l’espacement et les sauts de ligne à votre code Power Apps. Utilisez la commande « Formater le texte » pour conserver un style de codage cohérent dans votre application canevas et éviter les erreurs.

Étape suivante

Optimisation du code