Checkliste für die Entwicklung von PHP-Erweiterungen

Der Inhalt dieses Artikels handelt von der PHP-Erweiterungstestliste, die einen gewissen Referenzwert hat. Jetzt können Freunde in Not darauf verweisen.

Um ein erfolgreiches PHP-Erweiterungspaket zu erstellen, reicht es nicht aus, den Code einfach in einem Ordner abzulegen. Darüber hinaus gibt es viele Faktoren, die darüber entscheiden, ob Ihre Erweiterung ausgezeichnet ist. Die folgende Checkliste wird Ihnen dabei helfen, Ihre Erweiterung aufzupolieren und mehr Aufmerksamkeit in der PHP-Community zu erlangen.

1. Wählen Sie einen korrekten und passenden Namen für Ihre Erweiterung

• Stellen Sie sicher, dass Ihr Name nicht von anderen Projekten verwendet wird.

• Der Name der Erweiterung muss mit Ihrem PHP-Namespace übereinstimmen.

• Verwenden Sie in Ihrem Namensraum weder Ihren eigenen Namen noch einen anderen persönlichen Namen.

2. Machen Sie Ihre Erweiterung Open Source

• GitHub kann diese Art von öffentlichen Projekten kostenlos verwalten.

• GitHub ist für Sie sehr hilfreich, um dieses Open-Source-Projekt zu verwalten und es anderen leicht zu machen, Ihre Erweiterungen zu erhalten.

• Wenn Sie es nicht verwenden möchten, können Sie Alternativen ausprobieren: Bitbucket.

3. Seien Sie freundlich zum automatischen Laden

• Verwenden Sie den PSR-4-kompatiblen Autoloader-Namespace.

• Bitte legen Sie den Code im Ordner src ab.

4. Veröffentlichen Sie über Composer

• Stellen Sie sicher, dass Ihre Klassenbibliothek über Composer gefunden werden kann, einem Abhängigkeitsverwaltungstool für PHP

• Veröffentlicht auf Packagist, einem großen Composer-Paket-Repository.

5. Nicht auf Frameworks beschränkt

• Seien Sie nicht auf Projekte beschränkt, die nur auf einem Framework verwendet werden können.

• Bieten Sie besondere Unterstützung für das Framework durch Dienstleister.

6. Befolgen Sie einen Codierungsstil

• Es wird dringend empfohlen, dass Sie sich an den PSR-2-Codierungsstil halten.

• Verwenden Sie automatische Codeformatierungstools wie PHP Coding Standards Fixer.

• Verwenden Sie ein Codestil-Erkennungstool wie PHP Code Sniffer.

7. Unit-Tests schreiben

• decken den größten Teil des Codes ab.

• Verwenden Sie PHPUnit, ein häufig verwendetes PHP-Unit-Test-Framework.

• Andere Optionen: phpspec, Behat, atoum, Codeception.

8. Schreiben Sie Kommentare für den Code

• Behandeln Sie Kommentare als integrierte Dokumentation.

• Codekommentare können auch die Code-Autovervollständigungsfunktion von IDEs wie PhpStorm verbessern.

• kann automatisch in API-Dokumentation umgewandelt werden, siehe phpDocumentor.

9. Verwenden Sie die semantische Versionsverwaltung

• Verwenden Sie die semantische Versionsnummer, um die Versionsnummer zu verwalten.

• Befolgen Sie die Versionsspezifikation „Hauptversion.Nebenversion.Patch“.

• Ermöglicht Entwicklern ein sicheres Software-Upgrade, ohne sich Gedanken über fehlerhafte Änderungen machen zu müssen.

• Bitte denken Sie daran, die Release-Version rechtzeitig zu markieren!

10. Führen Sie ein regelmäßiges Update-Protokoll

• Markieren Sie wesentliche Änderungen zwischen den Versionen deutlich und zeigen Sie sie an.

• Erwägen Sie, dem Format „Keep a CHANGELOG“ zu folgen.

11. Verwenden Sie kontinuierliche Integration

• Verwenden Sie Dienste, um automatisch zu überprüfen, ob die Codierung Standard ist und laufende Tests bestehen kann.

• Es wäre eine gute Idee, den Test auf mehreren verschiedenen PHP-Versionen auszuführen.

• Stellen Sie sicher, dass es beim Senden oder Ziehen automatisch ausgeführt werden kann.

• Referenz: Travis-CI, Prüfer, Circle-CI.

12. Verfassen Sie eine ausführliche Nutzungsdokumentation

• Eine hervorragende Dokumentation ist für ein Erweiterungspaket von entscheidender Bedeutung.

• Stellen Sie zumindest sicher, dass in der Bibliothek eine ausführliche README-Datei vorhanden ist.

• Sie können versuchen, Dokumente in GitHub Pages zu hosten.

• Verfügbare Referenzen: Lesen Sie die Dokumente.

13. Enthält eine Lizenz

• Enthält eine Lizenzvereinbarung, die Ihre Arbeitsergebnisse effektiv schützen kann und sehr einfach durchzuführen ist.

• Siehe Choosealicense.com. Die meisten PHP-Open-Source-Projekte verwenden die MIT-Lizenz.

• Fügen Sie mindestens eine LIZENZ-Datei in die Codebasis ein.

• Denken Sie auch daran, Ihre Lizenzvereinbarung in Docblocks aufzunehmen.

14. Jeder Beitrag ist willkommen

• Wenn Sie möchten, dass jeder zur Verbesserung des Projekts beiträgt, müssen Sie um Ihren Beitrag bitten!

• Es gibt eine CONTRIBUTING-Datei mit der Liste der Mitwirkenden.

• Verwenden Sie dieses Dokument, um die Anforderungen an die Projektumgebung zu erläutern, beispielsweise eine Testumgebung.

Weitere moderne PHP-Kenntnisse finden Sie in der Laravel / PHP Knowledge Community

Verwandte Empfehlungen:

PHP-Zusammenfassung der Tutorials zur Erweiterungsentwicklung

PHP-Erweiterungsentwicklung

Das obige ist der detaillierte Inhalt vonCheckliste für die Entwicklung von PHP-Erweiterungen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!