Codelesbarkeit

Codelesbarkeit ist ein wichtiger Aspekt der App-Entwicklung, der häufig übersehen wird. Lesbarer Code ist einfacher zu verstehen, zu verwalten und zu debuggen.

Namenskonventionen

Konsistente Benennungskonventionen verbessern die Lesbarkeit ihres Codes erheblich. Es hilft Ihnen, den Zweck der einzelnen Elemente in Ihrer App schnell zu identifizieren und die Navigation durch Ihre Codebasis zu vereinfachen.

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.

Camel Case

Verwenden Sie CamelCase für Steuerelemente und Variablen. 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

Verwenden Sie die Pascal-Schreibweise für Datenquellen. 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ß. Anders als beim Camel Case wird beim Pascal Case jedoch auch das erste Wort großgeschrieben. Beispielsweise ist eine allgemeine Datenquelle in Power Apps der Microsoft Office 365 Users Connector, der office365Users im Code heißt.

Bildschirmnamen

Wählen Sie Bildschirmnamen aus, die den Zweck des Bildschirms deutlich anzeigen, wodurch die Navigation durch komplexe Apps in Power Apps Studio erleichtert wird.

Bildschirmlesegeräte lesen Bildschirmnamen laut vor. Benutzer mit Sehbehinderungen sind auf diese Bildschirmleseprogramme angewiesen. Verwenden Sie einfache Sprache für Bildschirmnamen, schließen Sie Leerzeichen ein, und vermeiden Sie Abkürzungen. Beenden Sie jeden Namen mit dem Wort "Bildschirm", um einen klaren Kontext anzugeben, wenn der Name angekündigt 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

Verwenden Sie CamelCase für alle Steuerelementnamen auf der Canvas. Beginnen Sie mit einem dreistelligen Typdeskriptor, 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.

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

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, können Sie den Namen in der Power Apps-App nicht ändern. Der Name wird vom Quellkonnektor oder den Datenentitäten übernommen, die aus der Verbindung abgeleitet werden.

Hier sehen Sie einige Beispiele:

• Name, der vom Quell-Connector geerbt wurde: Der Office 365 Users-Connector 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 Employeesder Name der Datenquelle in Ihrem Code . 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 Connectors für Canvas-Apps.

Standardaktionsverbindungen

In Standard-Aktionsconnectors, die Funktionen bereitstellen, wie z. B. LinkedIn, wird der Name der Datenquelle und deren Vorgänge in Pascal-Groß-/Kleinschreibung verwendet. Die LinkedIn-Datenquelle wird beispielsweise benannt LinkedIn und hat einen Vorgang mit dem Namen ListCompanies.

ClearCollect(
    colCompanies,
    LinkedIn.ListCompanies()
)

Benutzerdefinierte Konnektoren

Verwenden Sie benutzerdefinierte Connectors, um eine Verbindung mit benutzerdefinierten APIs (Application Programming Interfaces) herzustellen, wie z. B. mit Diensten oder APIs für Geschäftsbereiche, die Ihr Unternehmen erstellt. Jeder Hersteller in Ihrer Umgebung kann benutzerdefinierte Connectors erstellen. Verwenden Sie Pascal-Notation für den Namen der Datenquelle und deren Operationen. Der Name des benutzerdefinierten Connectors und die Art und Weise, wie er in Power Apps angezeigt wird, kann unterschiedlich sein.

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

Wenn Sie eine Verbindung aus diesem Connector erstellen und sie ihrer Power Apps-App als Datenquelle hinzufügen, wird sie als AuctionItemBidAPIDatenquelle angezeigt.

Um den Grund zu ermitteln, suchen Sie in der OpenAPI-Datei nach einem Titelattribute, das den Text Auction Item Bid APIenthält.

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

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

Excel-Datentabellen

Power Apps verwendet DataTables in Microsoft Excel, um eine Verbindung mit 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 übermäßig generische 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 z. B. konsistent 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. Diese Freigabe kann Verwirrung verursachen, da Ihre Formeln standardmäßig Kontextvariablen verwenden, es sei denn, Sie verwenden den Mehrdeutigkeitsoperator.

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

• Verwenden Sie loc als Präfix für Kontextvariablen.
• Stellen Sie globalen Variablen gbl voran.
• Der Name nach dem Präfix sollte die Absicht oder den Zweck der Variablen angeben. Sie können mehrere Wörter verwenden, ohne sie durch Sonderzeichen zu trennen, z. B. Unterstriche, wenn Sie den ersten Buchstaben jedes Worts großschreiben.
• Verwenden Sie CamelCase. 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. Verwenden Sie stattdessen EmployeeId.

Wenn eine App über viele Variablen verfügt, geben Sie das Präfix in die Bearbeitungsleiste ein, um eine Liste der verfügbaren Variablen anzuzeigen. Wenn Sie diese Richtlinien befolgen, um Ihre Variablen zu benennen, können Sie sie während der Entwicklung Ihrer App ganz einfach in der Bearbeitungsleiste finden. Letztlich führt dieser Ansatz zu einer schnelleren und effizienteren App-Entwicklung.

Sammlungsnamen

• Verwenden Sie Namen, die den Inhalt der Auflistung beschreiben. Überlegen Sie, was die Sammlung enthält und wie sie verwendet wird, und benennen Sie sie entsprechend.
• Präfixauflistungsnamen mit col.
• Verwenden Sie den Namen nach dem Präfix, um die Absicht oder den Zweck der Sammlung zu verdeutlichen. Sie können mehrere Wörter ohne Leerzeichen oder Unterstriche verwenden, wenn Sie den ersten Buchstaben jedes Worts großschreiben.
• Verwenden Sie CamelCase. Beginnen Sie ihre Auflistungsnamen mit einem Präfix in Kleinbuchstaben col , und großschreiben Sie dann den ersten Buchstaben jedes Worts im Namen.

Die folgenden Beispiele folgen den Konventionen für Sammlungsnamen:

• colMenuItems
• colThriveApps

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

• orderscoll
• tempCollection

Kommentare und Dokumentation

Wenn Sie Code für Ihre Anwendung schreiben, konzentrieren Sie sich darauf, klare Kommentare hinzuzufügen. Kommentare helfen Ihnen, den Code später zu verstehen und es dem nächsten Entwickler einfacher zu machen, am 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. Dieser Ansatz hilft, wenn Ihre Kommentare vor einem Codeblock angezeigt werden.

/*
    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 anderen Stellen innerhalb 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 es das Client-App-Paket erstellt. Kommentare wirken sich nicht auf paketgröße, App-Downloadgeschwindigkeit oder Ladezeiten aus.

Moderner App-Designer mit Kommentaren

Verwenden Sie in Power Apps sowohl die Kommentarfunktionen in Power Apps Studio als auch im modernen App-Designer.

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

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

Wenn Sie einen Kollegen in einem Kommentar erwähnen, verwenden Sie das @-Symbol gefolgt von seinem Namen. Diese Aktion sendet eine Benachrichtigungs-E-Mail an die Person, die Sie kategorisieren. 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

Einzüge und Formatierungen helfen dabei, Ihre App klar und übersichtlich zu gestalten. Wenn Ihr Code gut formatiert ist, ist es einfacher zu lesen und zu verstehen.

Einrücken

Power Apps erzwingt keinen strengen Einzug. Verwenden Sie Leerzeichen, um verschiedene Abschnitte Ihrer Formeln zu trennen. Drücken Sie mehrmals die LEERTASTE, um einen Einzug zu erstellen.

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 Bearbeitungsleiste 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 Ihrer Canvas-App beizubehalten und Fehler zu vermeiden.

Verwandte Informationen

• Verwenden konsistenter Benennungskonventionen in Power Automate-Cloudflüssen
• Erstellen lesbarer und wartungsfähiger Skripts in Power Automate-Desktopflüssen

Nächster Schritt