Codelesbarkeit

Namenskonventionen

Namenskonventionen – Allgemeines

In diesem Abschnitt werden die Namenskonventionen „Camel Case“ und „Pascal Case“ beschrieben. Wenn Sie mit diesen Begriffen bereits vertraut sind, können Sie diese Abschnitte überspringen.

Camelcase

Sie sollten für Steuerelemente und Variablen Camel Case verwenden. Camel Case beginnt mit einem Kleinbuchstabenpräfix, entfernt alle Leerzeichen aus Objekt- oder Variablennamen und schreibt den ersten Buchstaben jedes Worts nach dem ersten groß. Ein Texteingabesteuerelement könnte beispielsweise txtUserEmailAddress heißen.

Pascal-Case

Sie sollten für Datenquellen die Pascal-Schreibweise verwenden. Die Pascal-Schreibweise wird manchmal auch als Großbuchstaben-Kamel-Schreibweise bezeichnet. Wie die Kamel-Schreibweise entfernt sie alle Leerzeichen und schreibt den ersten Buchstaben von Wörtern groß. Im Unterschied zum Camel Case wird beim Pascal Case jedoch auch das erste Wort groß geschrieben. Eine gängige Datenquelle in PowerApps ist beispielsweise der Microsoft Office 365-Benutzende-Connector, der in Ihrem Code „Office365Users“ heißt.

Bildschirmnamen

Bildschirmnamen sollten den Zweck des Bildschirms widerspiegeln, um Navigation durch komplexe Apps in Power Apps Studio zu erleichtern.

Weniger offensichtlich ist, dass Bildschirmnamen von Bildschirmleseprogrammen vorgelesen werden, die für Benutzer mit sehbehindertengerechter Bedienung erforderlich sind. Daher ist es zwingend erforderlich, dass Sie für die Benennung Ihrer Bildschirme eine einfache Sprache verwenden und dass die Namen Leerzeichen und keine Abkürzungen enthalten. Außerdem empfehlen wir, den Namen mit dem Wort „Bildschirm“ zu beenden, sodass der Kontext, wenn der Name ausgesprochen wird, verstanden wird.

Hier sehen Sie einige gute Beispiele:

• Home_Screen oder Home Screen
• Search_Screen oder Search Screen

Diese Beispiel-Bildschirmnamen sind weniger verständlich:

• Home
• LoaderScreen
• EmpProfDetails
• Thrive Help

Steuerelementnamen

Alle Steuerelementnamen auf der Leinwand sollten Camel Case verwenden. Sie sollten mit einem dreistelligen Deskriptor beginnen, gefolgt vom Zweck des Steuerelements. Dieser Ansatz hilft dabei, den Steuerungstyp zu identifizieren und erleichtert das Erstellen von Formeln und die Suche. Beispielsweise gibt lblUserName an, dass es sich bei dem Steuerelement um eine Beschriftung handelt.

In der folgenden Tabelle sind die Abkürzungen für gängige Steuerelemente aufgeführt.

Steuerelementname	Abkürzung
Badge	bdg
Button	btn
Kamera-Steuerelement	cam
Canvas	can
Card	crd
Diagramme	chr
CheckBox	chk
Sammlung	col
Combo box	cmb
Komponente	cmp
Container	con
Datumsangaben	dte
Dropdown	drp
Form	frm
Galerie	gal
Gruppieren	GRP
Header	hdr
HTML-Text	htm
Schaltfläche	ico
Image	img
Info-Schaltfläche	-Info
Label	lbl
Verknüpfung	lnk
Listenfeld	lst
Mikrofon	mic
Microsoft Stream	str
Form des Seitenabschnitts	s
Stifteingabe	pen
Power BI-Kachel	pbi
Statusanzeige	pbar
Rating	rtg
Rich-Text-Editor	rte
Formen (Rechteck, Kreis usw.)	shp
Schieberegler	sld
Registerkartenliste	tbl
Table	tbl
Texteingabe	Txt
Selbstauslöser	tmr
Umschaltfläche	tgl
Video	vid

Eine detaillierte Liste der Steuerelemente und ihrer Eigenschaften finden Sie in der Steuerelementereferenz.

Anmerkung

Steuerelementnamen müssen innerhalb einer Anwendung eindeutig sein. Wenn ein Steuerelement auf mehreren Bildschirmen wiederverwendet wird, sollte der kurze Bildschirmname ein Suffix haben. Zum Beispiel galBottomNavMenuHS, wobei HS Startbildschirm bedeutet. Dieser Ansatz erleichtert das Verweisen auf das Steuerelement in Formeln über Bildschirme hinweg.

Hier sehen Sie einige schlechte Beispiele:

• zipcode
• Next

Wenn Sie Ihre Steuerelemente konsistent benennen, ist Ihre App in der Navigationsansicht übersichtlicher und auch Ihr Code ist übersichtlicher.

Datenquellennamen

Wenn Sie Ihrer Anwendung eine Datenquelle hinzufügen, kann der Name in der Power Apps-App nicht geändert werden. Der Name wird vom Quellkonnektor oder den Datenentitäten übernommen, die aus der Verbindung abgeleitet werden.

Hier sehen Sie einige Beispiele:

• Vom Quellconnector geerbter Name: Der Office 365-Benutzende-Konntektor heißt in Ihrem Code Office365Users.
• Aus der Verbindung abgeleitete Datenentitäten: Eine Microsoft- SharePoint Liste mit dem Namen Employees wird vom SharePoint Connector zurückgegeben. Daher lautet der Name der Datenquelle in Ihrem Code „Employees“. Dieselbe Power Apps App kann auch denselben SharePoint Connector verwenden, um auf eine SharePoint Liste mit dem Namen Contractors zuzugreifen. In diesem Fall lautet der Name der Datenquelle im Code Contractors.

Weitere Informationen zu Connectors und Verbindungen finden Sie in der Übersicht über Canvas-App-Connectors für Power Apps.

Standardaktions-Connectors

In Standard-Aktionskonnektoren, die Funktionen verfügbar machen, wie z. B. LinkedIn, wird für den Datenquellennamen und seine Vorgänge die Pascal-Schreibweise verwendet. Beispielsweise heißt die LinkedIn-Datenquelle LinkedIn und verfügt über eine Operation namens ListCompanies.

ClearCollect(
    colCompanies,
    LinkedIn.ListCompanies()
)

Benutzerdefinierte Konnektoren

Benutzerdefinierte Connectors zum Herstellen einer Verbindung mit benutzerdefinierten Anwendungsprogrammierschnittstellen (APIs), wie z. B. Diensten oder branchenspezifischen APIs, die Ihr Unternehmen erstellt hat. Sie können von jedem Erstellenden in Ihrer Umgebung erstellt werden. Wir empfehlen die Pascal-Schreibweise für den Datenquellennamen und seine Operationen. Beachten Sie jedoch, dass sich der Name des benutzerdefinierten Connectors und seine Darstellung in PowerApps unterscheiden können.

Betrachten Sie dieses Beispiel eines benutzerdefinierten Konnektors mit dem Namen MS Auction Item Bid API.

Wenn Sie jedoch von diesem Connector aus eine Verbindung erstellen und ihn Ihrer PowerApps-App als Datenquelle hinzufügen, erscheint er als AuctionItemBidAPI.

Um den Grund herauszufinden, können Sie in der OpenAPI-Datei nach einem Titelattribut suchen, das den Text Auction Item Bid API enthält.

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

Power Apps entfernt alle Leerzeichen aus diesem Attributwert und verwendet ihn als Namen Ihrer Datenquelle.

Trinkgeld

Wir empfehlen, den Wert dieses Attributs in einen Namen mit Pascal-Case AuctionItemBidAPI zu ändern und ihn als Namen Ihrer benutzerdefinierten Verbindung zu verwenden. Auf diese Weise kommt es zu keiner Verwirrung. Ändern Sie diesen Wert, bevor Sie die OpenAPI Datei importieren, um den benutzerdefinierten Connector zu erstellen.

Anmerkung

Wenn Sie die Option Von Grund auf neu erstellen verwenden, statt eine vorhandene OpenAPI Datei zu importieren, PowerApps werden Sie aufgefordert, den benutzerdefinierten Connector-Namen einzugeben. Dieser Name wird sowohl als Name des benutzerdefinierten Connectors als auch als Wert des Titelattributs in der Datei OpenAPI verwendet. Achten Sie darauf, einen Namen in Pascal-Schreibweise wie AuctionItemBidAPI zu verwenden, um die Konsistenz und Einfachheit zu wahren.

Excel-Datentabellen

PowerApps verwendet DataTables in Microsoft Excel, um eine Verbindung zu Daten in Excel-Arbeitsblättern herzustellen. Beachten Sie diese Punkte, wenn Sie Excel-Dokumente als Datenquellen erstellen:

• Geben Sie Ihren DataTables aussagekräftige Namen. Der Name steht in der Power Apps App, wenn Sie den Code zum Herstellen einer Verbindung damit schreiben.
• Verwenden Sie eine DataTable pro Arbeitsblatt.
• Geben Sie der DataTable und dem Arbeitsblatt den gleichen Namen.
• Verwenden Sie in den DataTables aussagekräftige Spaltennamen.
• Verwenden Sie die Pascal-Schreibweise. Jedes Wort des DataTable-Namens sollte mit einem Großbuchstaben beginnen, z. B.: EmployeeLeaveRequests

Variablennamen

Namenskonventionen für Variablen in Canvas-Apps sind für die Lesbarkeit, Konsistenz und Klarheit Ihrer Power Apps-Projekte wichtig. Es wird zwar kein strenger Standard erzwungen, aber die Einführung einer konsistenten Namenskonvention für Ihre Canvas-App kann es Ihnen und anderen Mitarbeitern erleichtern, die Variablen zu verstehen, zu verwenden und zu verwalten.

• Verwenden Sie Camel Case, wobei der erste Buchstabe jedes Wortes mit Ausnahme des ersten Wortes groß geschrieben wird.
• Wählen Sie aussagekräftige und beschreibende Namen, die den Zweck oder Inhalt der Variable klar beschreiben. Vermeiden Sie zu allgemeine Namen wie temp oder var1. Verwenden Sie stattdessen beschreibende Namen wie „userEmail“ oder „totalAmount“.
• Erwägen Sie die Verwendung von Präfixen oder Suffixen, um den Variablentyp anzugeben. Beispielsweise:
  • strUserName für eine Text-/Zeichenfolgenvariable
  • numTotalAmount für eine numerische Variable
  • boolIsEnabled für eine boolesche Variable
  • locVarName für lokale Variablen/Kontextvariablen
  • gblVarLoginUser für globale Variablen
• Entscheiden Sie, ob Ihre Variablen im Singular oder Plural benannt werden sollen, und halten Sie sich an diese Konvention. Verwenden Sie beispielsweise durchgängig „userCount“ oder „users“.
• Vermeiden Sie die Verwendung von reservierten Wörtern oder Namen, die mit Power Apps Funktionen oder Schlüsselwörtern in Konflikt geraten könnten. Eine Liste der reservierten Wörter finden Sie in der Power Apps Dokumentation.
• Erwägen Sie die Verwendung von Präfixen, die Kontext zur Verwendung oder zum Umfang der Variablen bieten. Beispiel:
  • frm für Formularvariablen
  • col für Sammlungen
  • var für Allzweckvariablen
• Verwenden Sie keine Sonderzeichen. Achten Sie auf alphanumerische Namen und vermeiden Sie Sonderzeichen oder Leerzeichen. Verwenden Sie nur Buchstaben und Zahlen.

Power Apps erlaubt, dass Kontext- und globale Variablen sich den gleichen Namen teilen. Dies kann zu Verwirrung führen, da Ihre Formeln standardmäßig Kontextvariablen verwenden, sofern nicht der Begriffsklärungsoperator verwendet wird.

Vermeiden Sie diese Situation, indem Sie die folgenden Konventionen befolgen:

• Stellen Sie Kontextvariablen loc voran.
• Stellen Sie globalen Variablen gbl voran.
• Der Name nach dem Präfix sollte die Absicht/den Zweck der Variable angeben. Es können mehrere Wörter verwendet werden und sie müssen nicht durch Sonderzeichen wie Leerzeichen oder Unterstriche getrennt werden, sofern der erste Buchstabe jedes Wortes groß geschrieben ist.
• Verwenden Sie Camel-Case-Schreibweisen. Beginnen Sie Ihre Variablennamen mit einem Präfix in Kleinbuchstaben und schreiben Sie dann den ersten Buchstaben jedes Wortes im Namen groß.

Diese Beispiele folgen Standards und Konventionen:

• Globale Variable:gblFocusedBorderColor

• Kontextvariable:locSuccessMessage

• Bereichsvariable:scpRadius

Diese Beispiele entsprechen nicht den Standards und sind schwieriger zu verstehen:

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

Vermeiden Sie kurze und kryptische Variablennamen wie EID. Nehmen Sie stattdessen Use EmployeeId.

Wenn eine App viele Variablen enthält, können Sie einfach das Präfix in die Formelzeile eingeben, um eine Liste der verfügbaren Variablen anzuzeigen. Wenn Sie sich an diese Richtlinien zum Benennen Ihrer Variablen halten, können Sie sie beim Entwickeln Ihrer App problemlos in der Formelzeile finden. Letztendlich führt dieser Ansatz zu einer schnelleren App-Entwicklung.

Sammlungsnamen

• Beschreiben Sie den Inhalt der Sammlung. Überlegen Sie, was die Sammlung enthält und/oder wie sie verwendet wird, und benennen Sie sie entsprechend.
• Sammlungen sollte col vorangestellt werden.
• Der Name nach dem Präfix sollte die Absicht oder den Zweck der Sammlung angeben. Es können mehrere Wörter verwendet werden, die auch nicht unbedingt durch Leerzeichen oder Unterstriche getrennt werden müssen, sofern der erste Buchstabe jedes Wortes groß geschrieben wird.
• Verwenden Sie Camel-Case-Schreibweisen. Beginnen Sie Ihre Sammlungsnamen mit dem Präfix „col“ in Kleinbuchstaben und schreiben Sie dann den ersten Buchstaben jedes Wortes im Namen groß.

Die folgenden Beispiele folgen den Konventionen für Sammlungsnamen:

• colMenuItems
• colThriveApps

Die folgenden Beispiele folgen nicht den Konventionen für Sammlungsnamen:

• orderscoll
• tempCollection

Trinkgeld

Wenn die App viele Sammlungen enthält, können Sie einfach das Präfix in die Formelleiste eingeben, um eine Liste der verfügbaren Sammlungen anzuzeigen. Wenn Sie diese Richtlinien zum Benennen Ihrer Sammlungen befolgen, können Sie sie bei der Entwicklung Ihrer App leicht in der Formelleiste finden. Letztendlich führt dieser Ansatz zu einer schnelleren App-Entwicklung.

Kommentare und Dokumentation

Wenn Sie Code für Ihre Anwendung schreiben, konzentrieren Sie sich darauf, klare Kommentare hinzuzufügen. Kommentare helfen Ihnen, Ihren Code später zu verstehen und erleichtern es dem nächsten Entwickler, an dem Projekt zu arbeiten.

Power Apps unterstützt zwei Kommentarstile, um Ihren Code klarer zu gestalten: Zeilenkommentare, die doppelte Schrägstriche (//) für einzeilige Notizen verwenden, und Blockkommentare, die /* und */ für mehrzeilige Notizen verwenden.

Zeilenkommentare

Fügen Sie einer beliebigen Codezeile // einen doppelten Schrägstrich in Power Apps hinzu, um den Rest der Zeile zu einem Kommentar zu machen.

Verwenden Sie Zeilenkommentare, um zu erklären, was die nächste Codezeile bewirkt. Sie können sie auch verwenden, um eine Codezeile zu Testzwecken vorübergehend zu deaktivieren.

Hier sehen Sie ein Beispiel für einen Zeilenkommentar.

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

Blockkommentare

Text zwischen /* und */ ist ein Blockkommentar. Blockkommentare können mehrere Zeilen umfassen, im Gegensatz zu Zeilenkommentaren, die nur eine Zeile abdecken.

Verwenden Sie Blockkommentare für längere Erklärungen, z. B. zum Dokumentieren einer Codemodulkopfzeile. Sie können sie auch verwenden, um mehrere Codezeilen während des Testens oder Debuggens vorübergehend zu deaktivieren.

Fügen Sie für eine bessere Codeorganisation Kommentare hinzu, nachdem Sie die Funktion Text formatieren verwendet haben. Dies ist hilfreich, wenn Ihre Kommentare vor einem Codeblock stehen.

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

Die Funktion Text formatieren folgt diesen Regeln für Kommentare:

1. Wenn eine Eigenschaft mit einem Blockkommentar beginnt, wird ihr die nächste Codezeile hinzugefügt.
2. Wenn eine Eigenschaft mit einem Zeilenkommentar beginnt, wird die nächste Codezeile nicht hinzugefügt. Andernfalls wird der Code auskommentiert.
3. Zeilen- und Blockkommentare an anderer Stelle in der Eigenschaft werden der vorherigen Codezeile hinzugefügt.

Machen Sie sich keine Sorgen, dass Sie zu viele oder zu lange Kommentare hinzufügen. Power Apps entfernt alle Kommentare, wenn das Client-App-Paket erstellt wird, sodass sich Kommentare nicht auf die Paketgröße auswirken oder App-Downloads oder Ladezeiten verlangsamen.

Moderner App-Designer mit Kommentaren

In Power Apps ist es am besten, die Kommentarfunktionen sowohl in Power Apps Studio als auch im App-Designer zu verwenden.

Verwenden Sie diese Methoden in Power Apps Studio, um Kommentare hinzuzufügen:

1. Klicken Sie mit der rechten Maustaste auf die Auslassungspunkte („...“) eines beliebigen Elements in der Strukturansicht.
2. Klicken Sie mit der rechten Maustaste auf eine Komponente im Canvas-Bereich.
3. Wählen Sie die Schaltfläche „Kommentare“ in der Befehlsleiste in der oberen rechten Ecke des Bildschirms.

Wenn Sie einen Kollegen in einem Kommentar erwähnen, verwenden Sie das @-Symbol gefolgt von seinem Namen. Dadurch wird eine Benachrichtigungs-E-Mail an die Person gesendet, die Sie markieren. Wenn der markierte Benutzer keinen Zugriff auf die App hat, fordert Power Apps Sie auf, die App für ihn freizugeben.

Einrückung und Formatierung

In Power Apps tragen Einrückungen und Formatierungen dazu bei, dass Ihre App übersichtlich und organisiert bleibt. Wenn Sie bewährte Methoden befolgen, sind Formeln und Steuerelemente leichter zu lesen.

Bearbeitungsleiste

Einrücken

Power Apps erzwingt keine strikte Einrückung, aber Sie können Leerzeichen verwenden, um verschiedene Abschnitte Ihrer Formeln zu trennen. Drücken Sie mehrmals die Leertaste, um eine Einrückung zu erzeugen.

Zeilenumbrüche

Teilen Sie lange Formeln in mehrere Zeilen auf, damit sie leichter zu lesen sind. Drücken Sie die Eingabetaste, um einen Zeilenumbruch in die Formelleiste einzufügen.

Verwenden Sie den Befehl „Text formatieren“

Der Befehl Text formatieren in der Formelleiste fügt Ihrem Power Apps Code Einzüge, Abstände und Zeilenumbrüche hinzu. Verwenden Sie den Befehl Text formatieren, um einen konsistenten Codierungsstil in Ihrem Canvas-App beizubehalten und Fehler zu vermeiden.

Nächster Schritt

Codeoptimierung