Inhaltsverzeichnis
1. Wählen Sie einen korrekten und passenden Namen für Ihre Erweiterung
2. Machen Sie Ihre Erweiterung Open Source
3. Seien Sie freundlich zum automatischen Laden
4. Veröffentlichen Sie über Composer
5. Nicht auf Frameworks beschränkt
6. Befolgen Sie einen Codierungsstil
7. Unit-Tests schreiben
8. Schreiben Sie Kommentare für den Code
9. Verwenden Sie die semantische Versionsverwaltung
10. Führen Sie ein regelmäßiges Update-Protokoll
11. Verwenden Sie kontinuierliche Integration
12. Verfassen Sie eine ausführliche Nutzungsdokumentation
13. Enthält eine Lizenz
14. Jeder Beitrag ist willkommen
Heim Backend-Entwicklung PHP-Tutorial Checkliste für die Entwicklung von PHP-Erweiterungen

Checkliste für die Entwicklung von PHP-Erweiterungen

Apr 23, 2018 am 11:19 AM
php 检测

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

Checkliste für die Entwicklung von PHP-Erweiterungen

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!

Erklärung dieser Website
Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn

Heiße KI -Werkzeuge

Undresser.AI Undress

Undresser.AI Undress

KI-gestützte App zum Erstellen realistischer Aktfotos

AI Clothes Remover

AI Clothes Remover

Online-KI-Tool zum Entfernen von Kleidung aus Fotos.

Undress AI Tool

Undress AI Tool

Ausziehbilder kostenlos

Clothoff.io

Clothoff.io

KI-Kleiderentferner

AI Hentai Generator

AI Hentai Generator

Erstellen Sie kostenlos Ai Hentai.

Heißer Artikel

R.E.P.O. Energiekristalle erklärten und was sie tun (gelber Kristall)
3 Wochen vor By 尊渡假赌尊渡假赌尊渡假赌
R.E.P.O. Beste grafische Einstellungen
3 Wochen vor By 尊渡假赌尊渡假赌尊渡假赌
R.E.P.O. So reparieren Sie Audio, wenn Sie niemanden hören können
3 Wochen vor By 尊渡假赌尊渡假赌尊渡假赌
WWE 2K25: Wie man alles in Myrise freischaltet
3 Wochen vor By 尊渡假赌尊渡假赌尊渡假赌

Heiße Werkzeuge

Notepad++7.3.1

Notepad++7.3.1

Einfach zu bedienender und kostenloser Code-Editor

SublimeText3 chinesische Version

SublimeText3 chinesische Version

Chinesische Version, sehr einfach zu bedienen

Senden Sie Studio 13.0.1

Senden Sie Studio 13.0.1

Leistungsstarke integrierte PHP-Entwicklungsumgebung

Dreamweaver CS6

Dreamweaver CS6

Visuelle Webentwicklungstools

SublimeText3 Mac-Version

SublimeText3 Mac-Version

Codebearbeitungssoftware auf Gottesniveau (SublimeText3)

PHP 8.4 Installations- und Upgrade-Anleitung für Ubuntu und Debian PHP 8.4 Installations- und Upgrade-Anleitung für Ubuntu und Debian Dec 24, 2024 pm 04:42 PM

PHP 8.4 bringt mehrere neue Funktionen, Sicherheitsverbesserungen und Leistungsverbesserungen mit einer beträchtlichen Menge an veralteten und entfernten Funktionen. In dieser Anleitung wird erklärt, wie Sie PHP 8.4 installieren oder auf PHP 8.4 auf Ubuntu, Debian oder deren Derivaten aktualisieren. Obwohl es möglich ist, PHP aus dem Quellcode zu kompilieren, ist die Installation aus einem APT-Repository wie unten erläutert oft schneller und sicherer, da diese Repositorys in Zukunft die neuesten Fehlerbehebungen und Sicherheitsupdates bereitstellen.

CakePHP arbeitet mit Datenbank CakePHP arbeitet mit Datenbank Sep 10, 2024 pm 05:25 PM

Das Arbeiten mit der Datenbank in CakePHP ist sehr einfach. In diesem Kapitel werden wir die CRUD-Operationen (Erstellen, Lesen, Aktualisieren, Löschen) verstehen.

CakePHP Datum und Uhrzeit CakePHP Datum und Uhrzeit Sep 10, 2024 pm 05:27 PM

Um in cakephp4 mit Datum und Uhrzeit zu arbeiten, verwenden wir die verfügbare FrozenTime-Klasse.

CakePHP-Datei hochladen CakePHP-Datei hochladen Sep 10, 2024 pm 05:27 PM

Um am Datei-Upload zu arbeiten, verwenden wir den Formular-Helfer. Hier ist ein Beispiel für den Datei-Upload.

Besprechen Sie CakePHP Besprechen Sie CakePHP Sep 10, 2024 pm 05:28 PM

CakePHP ist ein Open-Source-Framework für PHP. Es soll die Entwicklung, Bereitstellung und Wartung von Anwendungen erheblich vereinfachen. CakePHP basiert auf einer MVC-ähnlichen Architektur, die sowohl leistungsstark als auch leicht zu verstehen ist. Modelle, Ansichten und Controller gu

CakePHP erstellt Validatoren CakePHP erstellt Validatoren Sep 10, 2024 pm 05:26 PM

Der Validator kann durch Hinzufügen der folgenden zwei Zeilen im Controller erstellt werden.

CakePHP-Protokollierung CakePHP-Protokollierung Sep 10, 2024 pm 05:26 PM

Die Anmeldung bei CakePHP ist eine sehr einfache Aufgabe. Sie müssen nur eine Funktion verwenden. Sie können Fehler, Ausnahmen, Benutzeraktivitäten und von Benutzern durchgeführte Aktionen für jeden Hintergrundprozess wie Cronjob protokollieren. Das Protokollieren von Daten in CakePHP ist einfach. Die Funktion log() wird bereitgestellt

So richten Sie Visual Studio-Code (VS-Code) für die PHP-Entwicklung ein So richten Sie Visual Studio-Code (VS-Code) für die PHP-Entwicklung ein Dec 20, 2024 am 11:31 AM

Visual Studio Code, auch bekannt als VS Code, ist ein kostenloser Quellcode-Editor – oder eine integrierte Entwicklungsumgebung (IDE) –, die für alle gängigen Betriebssysteme verfügbar ist. Mit einer großen Sammlung von Erweiterungen für viele Programmiersprachen kann VS Code c

See all articles