Deutsch
Deutsch
Beim Schreiben von PHP -Code ist es entscheidend für die Lesbarkeit und Wartbarkeit des Codes. Das manuelle Anpassen des Codes, um den neuesten PHP-Codierungsstandards einzuhalten, kann jedoch sehr langweilig und zeitaufwändig sein. Glücklicherweise können wir mit Hilfe von Tools für die Erzeugung von PHP -Code diesen Vorgang automatisieren und problemlos Codeausschnitte generieren, die den neuesten PHP -Codespezifikationen entsprechen.
In diesem Artikel wird ein gemeinsames Tool zur Erzeugung von PHP-Code erstellt-Php-CS-Fixer, mit dem die Spezifikationsprobleme im PHP-Code automatisch auf der Grundlage einer Reihe von voreingestellten Regeln behoben werden können.
Zunächst müssen wir Php-CS-Fixer installieren und konfigurieren. Führen Sie den folgenden Befehl aus der Befehlszeile aus, um zu installieren:
composer global require friendsofphp/php-cs-fixer
Denken Sie nach Abschluss der Installation daran, das Installationsverzeichnis zu den Systemumgebungsvariablen hinzuzufügen, damit wir in jedem Verzeichnis PHP-CS-Fixer verwenden können.
Nach der Installation des Tools können Sie den folgenden Befehl verwenden, um die Spezifikationsprobleme im Code zu überprüfen:
php-cs-fixer fix src/
Dieser Befehl durchquert alle PHP -Dateien im Verzeichnis "src/" und behebt Spezifikationsprobleme im Code gemäß den voreingestellten Regeln. Es ist zu beachten, dass der reparierte Code die Originaldatei direkt überschreibt. Daher wird empfohlen, eine Codesicherung durchzuführen, bevor dieser Befehl ausgeführt wird.
Zusätzlich zum manuellen Ausführen von Befehlen, um den Code des gesamten Projekts zu beheben, können wir die Regeln auch anpassen, indem wir die Konfigurationsdatei bearbeiten. Erstellen Sie eine Datei mit dem Namen `.php_cs.dist` im Stammverzeichnis des Projekts und füllen Sie den folgenden Inhalt aus:
<?php
$finder = PhpCsFixerFinder::create()
->exclude( 'vendor' )
->in(__DIR__);
return PhpCsFixerConfig::create()
->setRules([
'@PSR12' => true,
'trailing_comma_in_multiline' => true,
// 其他规则...
])
->setFinder( $finder );
In dieser Konfigurationsdatei definieren wir die Ordner und Dateien, die über "$ finder" überprüft werden müssen, und verwenden die "exklude" -Methode, um das Verzeichnis "Anbieter" auszuschließen. Anschließend wird das Konfigurationsobjekt über PHPCSFixerConfig :: Create erstellt und die Regeln werden mithilfe der SetRules -Methode definiert.
Zum Beispiel wird die Regel "@psr12" auf `true` gesetzt, was darauf hinweist, dass die neueste PSR-12-Codespezifikation befolgt wird. Sie können auch andere Regeln wie `Trailing_comma_in_multiline` anpassen, die Kommas zu einem Multi-Line-Array oder einer Parameterliste hinzufügen.
Nach der Konfiguration der Regeln müssen wir nur den folgenden Befehl ausführen, um den Code zu beheben:
php-cs-fixer fix
Dieser Befehl findet automatisch alle PHP -Dateien im aktuellen Verzeichnis.
Wenn Sie nur eine bestimmte Datei reparieren möchten, können Sie den Dateipfad nach dem Befehl angeben:
php-cs-fixer fix path/to/file.php
Durch die Verwendung von Tools für PHP-Codegenerierung wie PHP-CS-Fixer können wir die Konsistenz, Lesbarkeit und Wartbarkeit unseres Codes erheblich verbessern. Das Tool repariert nicht nur automatisch den Code basierend auf voreingestellten Regeln, sondern ermöglicht es uns auch, die Regeln anzupassen, um die Projektanforderungen besser zu erfüllen.
Obwohl diese Tools automatisch Probleme mit der Codespezifikation beheben können, wird weiterhin empfohlen, manuelle Bewertungen nach der Reparatur durchzuführen, um sicherzustellen, dass alle Reparaturvorgänge den tatsächlichen Anforderungen des Projekts entsprechen.
