Heim Backend-Entwicklung PHP-Tutorial Beitrag zu PHP: So tragen Sie zum Handbuch von PHP bei

Beitrag zu PHP: So tragen Sie zum Handbuch von PHP bei

Feb 15, 2025 pm 12:25 PM

Diese zweiteilige Serie untersucht, wie man zum PHP-Projekt beiträgt und sich auf Dokumentation in Teil 1 konzentriert. Wir decken Kontoanfragen und Nachabrechnungsschritte ab.

Contributing to PHP: How to Contribute to PHP's Manual

Schlüsselpunkte:

  • Beitrag zur Dokumentation von PHP verbessert die Sprache und erhöht Ihr PHP -Fachwissen. Es kann auch zu einem Php.NET -Konto führen, der die Richtung der Sprache beeinflusst.
  • Die Dokumentation verwendet Docbook XML; Vertrautheit ist hilfreich, aber nicht obligatorisch.
  • Anfänger können den Online -Editor für einfache Patches verwenden. Überprüfung der Richtlinien im Voraus sind ratsam.
  • Häufige Mitwirkende oder diejenigen, die umfangreiche Änderungen benötigen, sollten die DOCs lokal einrichten und ein Php.net -Konto anfordern. Dies beinhaltet das Erstellen eines Verzeichnisses, das Klonen der Dokumente und das Konfigurieren von SVN -Schlüsselwörtern.
  • Beiträge umfassen Fehlerbehebungen, Übersetzungen, Erweiterung vorhandener Inhalte, Dokumentation von undokumentierten Funktionen und allgemeine Verbesserungen.

Warum beitragen?

PHP, der Open-Source ist, lebt vom Engagement der Gemeinschaft. Die verstärkte Teilnahme kommt allen zugute. Unabhängig davon, ob es sich um die Verbesserung der Dokumentation, das Beheben von Fehler oder das Hinzufügen von Funktionen, zählt jeder Beitrag. Aktive Teilnahme vertieft Ihr PHP -Wissen und ermöglicht es Ihnen, ein Php.net -Konto anzufordern, wobei die Zukunft der Sprache gestaltet wird.

PHP -Dokumentation

verstehen

Die Dokumentation befindet sich in Docbook XML. Vorwissen ist nicht ausschließlich notwendig; Die XML -Syntax ist leicht zu lernen.

Die Verzeichnisstruktur lautet:

Contributing to PHP: How to Contribute to PHP's Manual

doc-base enthält Tools zum Konvertieren der XML -Dokumentation. en hält die englische Dokumentation (andere Sprachen verwenden ihre Zwei-Buchstaben-Codes). reference enthält erweiterungsspezifische Verzeichnisse (Funktionen für prozedurale Erweiterungen, klassenbezeichnete Ordner für objektorientierte). Jeder Erweiterungsordner enthält book.xml (Zielseite) und versions.xml (Versioning -Info).

Die Dokumentation ist derzeit SVN-basiert (obwohl er zu Git migriert). Lokales Setup erfordert eine SVN -Vertrautheit.

Erstmalige Mitwirkende

Beginnen Sie mit dem Online -Dokumentationseditor. Dies ermöglicht die Anmeldung von OAuth und die Einreichung einfacher Patches. Konsistente Konto Verwendung vereinfacht die Verfolgung von Beiträgen für zukünftige Php.net -Kontoanwendungen.

Machen Sie sich mit Style -Richtlinien vor, bevor Sie Patches einreichen.

Beispiel: Auflösen von Fehler #71716

Dieser Fehler meldet eine fehlerhafte MongoDB -Client -Klasse in einem Beispiel. Verwenden Sie nach der Überprüfung den Online -Editor, um den Namespace zu korrigieren.

Video -Einbetten: https://www.php.cn/link/14aa36297925d3c82891d74fa28d7df1 (ersetzen Sie es bei Bedarf durch den tatsächlichen Einbett -Code)

Lokales Setup

Der Online -Editor ist begrenzt; Richten Sie die DOCs lokal ein und fordern Sie ein php.net -Konto an.
    .
  1. phpdocs ein
  2. Verzeichnis erstellen.
  3. svn checkout https://svn.php.net/repository/phpdoc/modules/doc-en klonen Sie die Dokumente mit SVN:
  4. git clone http://git.php.net/repository/phd.git Klon -PhD (Rendering -Tool):
  5. git clone http://git.php.net/repository/web/php.git web-php klonen Sie die PHP.NET -Website: web-php/manual/en; Entfernen Sie
  6. und erstellen Sie eine symbolische Verbindung zu den gerenderten Dokumenten.
  7. ~/.subversion/config SVN -Schlüsselwörter in *.xml = svn:eol-style=native;svn:keywords=Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL:
  8. konfigurieren ref (optional) Erstellen Sie eine
  9. Datei mit Befehlen zur Validierung, Erstellung und Anzeige von Dokumenten lokal.

docs Workflow (lokal)

svn up Nach dem Einrichten aktualisieren Sie Repositories (git pull und php ~/phpdocs/doc-en/doc-base/configure.php). Bearbeiten Sie die entsprechende XML -Datei, validieren Sie mit svn ci -m "Resolve doc bug #..."), erstellen Sie mit PhD und starten Sie den lokalen Server. Bestimmungsänderungen mithilfe von SVN (

, verweisen Sie auf die Fehlernummer. Schließen Sie den Fehlerbericht auf der Registerkarte "Entwickler" nach der Verbreitung von Änderungen.

Anfordern eines php.net -Kontos

Fordern Sie nach lokalem Setup ein Php.NET -Konto bei DOCS Karma an. Während keine strengen Voraussetzungen vorhanden sind, ist es wichtig, einen aktiven Beitrag zu demonstrieren. Senden Sie das Kontokontoanforderungsformular und senden Sie eine E -Mail an phpdoc@lists.php.net, um Ihre Absichten, Wiki -Benutzernamen und frühere Beiträge zu erläutern.

Dokumentationsaufgaben

Beyond Fehlerbehebungen:
  • Übersetzungen
  • teilweise dokumentiertes Material
  • erweitern
  • Dokumentieren von undokumentierten Funktionen
Allgemeine Verbesserungen

Allgemeine Tipps
  • befolgen Sie die Stilrichtlinien.
  • Überprüfen Sie verwandte Aspekte bei der Behebung von Fehler.
  • präzise schreiben.
  • separates Beispielcode von Ausgabe.
  • korrekte Seitenreihenfolge sicherstellen.
  • PHP 4 Referenzen entfernen.
  • ordnungsgemäße Version neue Dateien.
wenden Sie sich an die FAQ- oder PHP-Docs-Mailingliste der DOCs.

Schlussfolgerung

Dieser Teil umfasste zwei Workflows: Online -Editor und lokales Setup. Teil zwei wird abdecken, der zum Kern von PHP beiträgt.

faqs (bewegt zum besseren Fluss)
  • beitragen Prozess: Erstellen Sie ein Konto, bearbeiten/erstellen Inhalte, übersetzen Sie Richtlinien.
  • Bedeutung des Beitrags: verbessert die Dokumentationsqualität, hält sie auf dem neuesten Stand, fördert die Community.
  • Stellen Sie sicher
  • Nicht-Muttersprachler:
  • Beiträge sind willkommen; Übersetzung ist ein wertvoller Beitrag.
  • Häufige Fehler:
  • Nicht -Richtlinien, ungenaue/unklare Informationen, Mangel an Korrekturlesen, unnötige Änderungen.
  • Hilfe erhalten:
  • Verwenden Sie Online -Foren, Diskussionsgruppen, Dokumentationsrichtlinien.
  • Anonymer Beitrag:
  • möglich, aber ein Konto wird gefördert.
  • Beitragshäufigkeit:
  • variiert je nach Verfügbarkeit und Interesse.
  • Entschädigung:
  • Im Allgemeinen Freiwilligenarbeit.
  • Meldungsfehler:
  • Korrigieren Sie sie, wenn ein Mitwirkender, ansonsten der Community Bericht erstattet.
  • Denken Sie daran, die Platzhalter -Bild -URLs durch die tatsächlichen Bild -URLs zu ersetzen. Ich habe die Bildformatierung bewahrt und die Bilder wie angefordert in ihren ursprünglichen Positionen aufbewahrt.

Das obige ist der detaillierte Inhalt vonBeitrag zu PHP: So tragen Sie zum Handbuch von PHP bei. 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

Video Face Swap

Video Face Swap

Tauschen Sie Gesichter in jedem Video mühelos mit unserem völlig kostenlosen KI-Gesichtstausch-Tool aus!

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)

Erklären Sie JSON Web Tokens (JWT) und ihren Anwendungsfall in PHP -APIs. Erklären Sie JSON Web Tokens (JWT) und ihren Anwendungsfall in PHP -APIs. Apr 05, 2025 am 12:04 AM

JWT ist ein offener Standard, der auf JSON basiert und zur sicheren Übertragung von Informationen zwischen Parteien verwendet wird, hauptsächlich für die Identitätsauthentifizierung und den Informationsaustausch. 1. JWT besteht aus drei Teilen: Header, Nutzlast und Signatur. 2. Das Arbeitsprinzip von JWT enthält drei Schritte: Generierung von JWT, Überprüfung von JWT und Parsingnayload. 3. Bei Verwendung von JWT zur Authentifizierung in PHP kann JWT generiert und überprüft werden, und die Funktionen und Berechtigungsinformationen der Benutzer können in die erweiterte Verwendung aufgenommen werden. 4. Häufige Fehler sind Signaturüberprüfungsfehler, Token -Ablauf und übergroße Nutzlast. Zu Debugging -Fähigkeiten gehört die Verwendung von Debugging -Tools und Protokollierung. 5. Leistungsoptimierung und Best Practices umfassen die Verwendung geeigneter Signaturalgorithmen, das Einstellen von Gültigkeitsperioden angemessen.

Was sind Aufzählungen (Enums) in PHP 8.1? Was sind Aufzählungen (Enums) in PHP 8.1? Apr 03, 2025 am 12:05 AM

Die Aufzählungsfunktion in Php8.1 verbessert die Klarheit und Type des Codes, indem benannte Konstanten definiert werden. 1) Aufzählungen können Ganzzahlen, Zeichenfolgen oder Objekte sein, die die Lesbarkeit der Code und die Type der Type verbessern. 2) Die Aufzählung basiert auf der Klasse und unterstützt objektorientierte Merkmale wie Traversal und Reflexion. 3) Die Aufzählung kann zum Vergleich und zur Zuordnung verwendet werden, um die Sicherheit der Typ zu gewährleisten. 4) Aufzählung unterstützt das Hinzufügen von Methoden zur Implementierung einer komplexen Logik. 5) Strenge Typ Überprüfung und Fehlerbehandlung können häufig auftretende Fehler vermeiden. 6) Die Aufzählung verringert den magischen Wert und verbessert die Wartbarkeit, achten Sie jedoch auf die Leistungsoptimierung.

Wie funktioniert die Session -Entführung und wie können Sie es in PHP mildern? Wie funktioniert die Session -Entführung und wie können Sie es in PHP mildern? Apr 06, 2025 am 12:02 AM

Die Hijacking der Sitzung kann in den folgenden Schritten erreicht werden: 1. Erhalten Sie die Sitzungs -ID, 2. Verwenden Sie die Sitzungs -ID, 3. Halten Sie die Sitzung aktiv. Zu den Methoden zur Verhinderung der Sitzung der Sitzung in PHP gehören: 1. Verwenden Sie die Funktion Session_regenerate_id (), um die Sitzungs -ID zu regenerieren. 2. Store -Sitzungsdaten über die Datenbank, 3. Stellen Sie sicher, dass alle Sitzungsdaten über HTTPS übertragen werden.

Beschreiben Sie die soliden Prinzipien und wie sie sich für die PHP -Entwicklung anwenden. Beschreiben Sie die soliden Prinzipien und wie sie sich für die PHP -Entwicklung anwenden. Apr 03, 2025 am 12:04 AM

Die Anwendung des soliden Prinzips in der PHP -Entwicklung umfasst: 1. Prinzip der Einzelverantwortung (SRP): Jede Klasse ist nur für eine Funktion verantwortlich. 2. Open and Close Principle (OCP): Änderungen werden eher durch Erweiterung als durch Modifikation erreicht. 3.. Lischs Substitutionsprinzip (LSP): Unterklassen können Basisklassen ersetzen, ohne die Programmgenauigkeit zu beeinträchtigen. 4. Schnittstellen-Isolationsprinzip (ISP): Verwenden Sie feinkörnige Schnittstellen, um Abhängigkeiten und nicht verwendete Methoden zu vermeiden. 5. Abhängigkeitsinversionsprinzip (DIP): Hoch- und niedrige Module beruhen auf der Abstraktion und werden durch Abhängigkeitsinjektion implementiert.

Erklären Sie die späte statische Bindung in PHP (statisch: :). Erklären Sie die späte statische Bindung in PHP (statisch: :). Apr 03, 2025 am 12:04 AM

Statische Bindung (statisch: :) implementiert die späte statische Bindung (LSB) in PHP, sodass das Aufrufen von Klassen in statischen Kontexten anstatt Klassen zu definieren. 1) Der Analyseprozess wird zur Laufzeit durchgeführt.

Was sind REST -API -Designprinzipien? Was sind REST -API -Designprinzipien? Apr 04, 2025 am 12:01 AM

Die RESTAPI -Designprinzipien umfassen Ressourcendefinition, URI -Design, HTTP -Methodenverbrauch, Statuscode -Nutzung, Versionskontrolle und Hassoas. 1. Ressourcen sollten durch Substantive dargestellt und in einer Hierarchie aufrechterhalten werden. 2. HTTP -Methoden sollten ihrer Semantik entsprechen, z. B. Get wird verwendet, um Ressourcen zu erhalten. 3. Der Statuscode sollte korrekt verwendet werden, z. B. 404 bedeutet, dass die Ressource nicht vorhanden ist. 4. Die Versionskontrolle kann über URI oder Header implementiert werden. 5. Hateoas startet Client -Operationen durch Links als Antwort.

Wie können Sie mit Ausnahmen in PHP effektiv umgehen (versuchen Sie, schließlich zu werfen)? Wie können Sie mit Ausnahmen in PHP effektiv umgehen (versuchen Sie, schließlich zu werfen)? Apr 05, 2025 am 12:03 AM

In PHP wird das Ausnahmebehandlung durch den Versuch, Fang, schließlich und werfen Keywords erreicht. 1) Der Try -Block umgibt den Code, der Ausnahmen auslösen kann. 2) Der Catch -Block behandelt Ausnahmen; 3) Block stellt schließlich sicher, dass der Code immer ausgeführt wird. 4) Wurf wird verwendet, um Ausnahmen manuell zu werfen. Diese Mechanismen verbessern die Robustheit und Wartbarkeit Ihres Codes.

Was sind anonyme Klassen in PHP und wann könnten Sie sie verwenden? Was sind anonyme Klassen in PHP und wann könnten Sie sie verwenden? Apr 04, 2025 am 12:02 AM

Die Hauptfunktion anonymer Klassen in PHP besteht darin, einmalige Objekte zu erstellen. 1. Anonyme Klassen ermöglichen es, Klassen ohne Namen direkt im Code zu definieren, was für vorübergehende Anforderungen geeignet ist. 2. Sie können Klassen erben oder Schnittstellen implementieren, um die Flexibilität zu erhöhen. 3. Achten Sie bei der Verwendung auf Leistung und Code -Lesbarkeit und vermeiden Sie es, dieselben anonymen Klassen wiederholt zu definieren.

See all articles