Suche…
Definieren Sie den Codestil für ein Projekt
PhpStorm bietet Standardeinstellungen für das Code-Styling für eine große Anzahl von Sprachen basierend auf bewährten Methoden und gängigen Standards. Sie können jedoch das Design für jede Sprache auf Projektbasis in PhpStorm-Einstellungen> Editor > Code-Stil anpassen.
Schemata
Schemas sind Sammlungen von Richtlinien und Einstellungen für den Codestil. Sie können ein Schema für ein Projekt auswählen und es wird sofort angewendet. Es gibt auch ein Projektschema, das nur verfügbar ist, wenn Sie ein Projekt geöffnet haben. Das Projektschema speichert die Richtlinien nicht in allgemeinen Benutzereinstellungen, sondern in den eigenen Einstellungen des Projekts.
Wenn Sie auf die Schaltfläche Verwalten klicken, können Sie ein neues Schema hinzufügen, um schnell einen neuen Satz von Code-Style-Richtlinien einzurichten. Das Feld " Verwalten " kann auch zum Exportieren oder Importieren von Schemata verwendet werden. Dies ist sehr hilfreich, wenn Sie Schemata mit Freunden oder Kollegen teilen möchten.
Ändern Sie den Stil für eine bestimmte Sprache
Um die Einstellungen für den Codestil für eine bestimmte Sprache zu ändern, klicken Sie einfach auf die verfügbare Sprache in der Seitenleiste. Sie erhalten dann eine Einstellungsseite, die für jede Sprache unterschiedlich ist.
Beispielsweise enthält die PHP-Sprache Einstellungen für Tabs und Leerzeichen, geschweifte Klammern oder PHP-Dokumente.
Wenn Sie wissen möchten, was die verschiedenen Einstellungen bedeuten, können Sie sie in der offiziellen Dokumentation nachschlagen.
Code-Style-Dokumentation für PhpStorm 2016 und höher
Erzwingen Sie einen angegebenen Code-Stil für ein Projekt über mehrere Teammitglieder hinweg
Derzeit gibt es keine One-Click-Button-Methode, um die Richtlinien für den Codestil tatsächlich in einem Team durchzusetzen, aber es gibt zwei Methoden, um sicherzustellen, dass ein bestimmter Codestil auf Ihr Produkt angewendet wird.
Importieren von PhpStorm-Codestilschemas
Die erste und einfachere Lösung besteht darin, ein Code-Style-Schema für Ihre eigene PhpStorm-Instanz einzurichten, das Schema auf ein tragbares Laufwerk oder ein Netzlaufwerk zu exportieren und das Schema auf allen Entwicklungscomputern zu importieren.
Auf diese Weise kann ein Entwickler die Tastenkombinationen Cmd + Shift + L (MacOS) oder Ctl + Alt + L (Windows / Linux) verwenden, um den gesamten Quellcode automatisch zu formatieren.
Detaillierte Informationen hierzu finden Sie in der folgenden Dokumentation:
Neuformatierung des Quellcodes in PhpStorm 2016 und höher
Cons
Leider gibt es keine Möglichkeit zu überprüfen, ob ein Entwickler die Code-Neuformatierung wirklich angewendet hat. Sie müssen sich auf die Zusagen der Entwickler verlassen, dass sie sich um die Neuformatierung kümmern.
Automatisierte Code-Formatprüfungen mit einem CI-Server
Eine sehr strenge Methode zur Steuerung der Quellcode-Formatierung besteht in der Implementierung eines fortlaufenden Integrationsservers wie Jenkins , der überprüfen kann, ob der Quellcode einem vordefinierten Codestil entspricht.
Angenommen, ein Entwickler hat an einem neuen Feature in seinem eigenen Entwicklungszweig gearbeitet und möchte seine Änderungen in das Haupt-Repository verschieben. Zuerst überträgt er die Änderungen in seinen eigenen Zweig, in dem die neue Funktion vom CI-Server geprüft wird. Wenn die Überprüfung fehlgeschlagen ist, weil der Code nicht ordnungsgemäß formatiert ist, wird der Entwickler benachrichtigt, sodass er die Probleme beheben kann.
Es gibt verschiedene Möglichkeiten, wie Sie Codequalitäts- und Formatierungsüberprüfungen mit allen verschiedenen Integrationsservern einrichten können. Die Erklärung, wie Sie einen Server mit Überprüfungen einrichten, sollte in den entsprechenden Tags erfolgen.
Legen Sie Code-Styles aus einem vordefinierten Standard wie PSR-2 fest
PhpStorm wird bereits mit vielen vordefinierten Sprachschemas ausgeliefert, die auf allgemeinen Code-Style-Richtlinien und -Standards wie PSR-2 basieren. Es gibt eine Art versteckte Funktion auf den Einstellungsseiten der Codestile, mit der Sie diese Standards importieren und als aktuelle Konfiguration festlegen können. Dazu wählen Sie einfach Ihre Programmiersprache im linken Feld aus. Dann gibt es oben rechts einen kleinen Link namens Set from ...
Wenn Sie auf diesen Link klicken, zeigt PhpStorm ein kleines Popup an, in dem Sie unter den vordefinierten Standards auf der Registerkarte Vordefinierter Stil auswählen können.
