PHP
Beitrag zum PHP-Handbuch
Suche…
Einführung
Das PHP-Handbuch enthält sowohl eine Funktionsreferenz als auch eine Sprachreferenz sowie Erklärungen der wichtigsten Funktionen von PHP. Das PHP-Handbuch fordert PHP-Entwickler im Gegensatz zu den meisten anderen Sprachen dazu auf, jeder Seite der Dokumentation eigene Beispiele und Hinweise hinzuzufügen. In diesem Thema werden der Beitrag zum PHP-Handbuch sowie Tipps, Tricks und Richtlinien für bewährte Verfahren erläutert.
Bemerkungen
Die Beiträge zu diesem Thema sollten hauptsächlich den Prozess beschreiben, in dem Sie Beiträge zum PHP-Handbuch leisten, z. B. erläutern, wie Sie Seiten hinzufügen, wie Sie sie zur Überprüfung einreichen, Bereiche finden, in denen ebenfalls Inhalte bereitgestellt werden können usw.
Verbessern Sie die offizielle Dokumentation
PHP hat bereits eine großartige offizielle Dokumentation unter http://php.net/manual/ . Das PHP-Handbuch dokumentiert so ziemlich alle Sprachfunktionen, die Kernbibliotheken und die meisten verfügbaren Erweiterungen. Es gibt viele Beispiele, von denen man lernen kann. Das PHP-Handbuch ist in mehreren Sprachen und Formaten verfügbar.
Das Beste ist, dass die Dokumentation für jeden frei ist .
Das PHP-Dokumentationsteam bietet einen Online-Editor für das PHP-Handbuch unter https://edit.php.net an . Es unterstützt mehrere Single-Sign-On-Dienste, einschließlich der Anmeldung bei Ihrem Stack Overflow-Konto. Eine Einführung in den Editor finden Sie unter https://wiki.php.net/doc/editor .
Änderungen am PHP-Handbuch müssen von Mitarbeitern des PHP-Dokumentationsteams mit Doc Karma genehmigt werden. Doc Karma ist ein bisschen wie ein Ruf, aber schwieriger zu bekommen. Dieser Peer-Review-Prozess stellt sicher, dass nur sachlich korrekte Informationen in das PHP-Handbuch aufgenommen werden.
Das PHP-Handbuch ist in DocBook geschrieben, einer einfach zu erlernenden Auszeichnungssprache für das Verfassen von Büchern. Es mag auf den ersten Blick etwas kompliziert aussehen, aber es gibt Vorlagen, um Ihnen den Einstieg zu erleichtern. Sie müssen sicherlich kein DocBook-Experte sein, um dazu beizutragen.
Tipps zum Mitmachen des Handbuchs
Im Folgenden finden Sie eine Liste mit Tipps für diejenigen, die Beiträge zum PHP-Handbuch leisten möchten:
- Befolgen Sie die Stilrichtlinien des Handbuchs . Stellen Sie sicher, dass die Stilrichtlinien des Handbuchs immer der Konsistenz halber eingehalten werden.
- Führen Sie Rechtschreib- und Grammatikprüfungen durch . Stellen Sie sicher, dass die richtige Rechtschreibung und Grammatik verwendet wird. Andernfalls ist es möglicherweise schwieriger, die angezeigten Informationen zu verarbeiten, und der Inhalt wirkt weniger professionell.
- Seien Sie knapp in Erklärungen . Vermeiden Sie es, die Informationen den Entwicklern, die schnell darauf verweisen möchten, klar und übersichtlich darzustellen.
- Code von der Ausgabe trennen . Dies gibt sauberere und weniger komplizierte Codebeispiele für Entwickler, die zu verdauen sind.
- Überprüfen Sie die Reihenfolge der Seitenabschnitte . Stellen Sie sicher, dass alle Abschnitte der bearbeiteten Handbuchseite in der richtigen Reihenfolge sind. Die Einheitlichkeit des Handbuchs erleichtert das schnelle Lesen und Nachschlagen von Informationen.
- Entfernen Sie PHP 4-bezogene Inhalte . Spezifische Erwähnungen zu PHP 4 sind nicht mehr relevant, da es jetzt alt ist. Erwähnungen sollten aus dem Handbuch entfernt werden, um zu verhindern, dass es mit unnötigen Informationen verschlungen wird.
- Ordnungsgemäße Versionsdateien . Stellen Sie beim Erstellen neuer Dateien in der Dokumentation sicher, dass die Revisions-ID der Datei wie folgt festgelegt ist:
<!-- $Revision$ -->. - Fügen Sie nützliche Kommentare in das Handbuch ein . Einige Kommentare liefern nützliche Informationen, von denen das Handbuch profitieren könnte. Diese sollten in den Inhalt der Hauptseite eingefügt werden.
- Brechen Sie den Dokumentationsaufbau nicht . Stellen Sie immer sicher, dass das PHP-Handbuch ordnungsgemäß erstellt wird, bevor Sie die Änderungen übernehmen.