PHP
Bidra till PHP Manual
Sök…
Introduktion
PHP-manualen ger både en funktionell referens och en språkreferens tillsammans med förklaringar av PHP: s huvudfunktioner. PHP-manualen, till skillnad från de flesta språkens dokumentation, uppmuntrar PHP-utvecklare att lägga till sina egna exempel och anteckningar till varje sida i dokumentationen. Detta ämne förklarar bidrag till PHP-manualen, tillsammans med tips, tricks och riktlinjer för bästa praxis.
Anmärkningar
Bidrag till detta ämne bör huvudsakligen beskriva processen kring att bidra till PHP-manualen, t.ex. förklara hur man lägger till sidor, hur man skickar in dem för granskning, hittar områden för att bidra med innehåll, och så vidare.
Förbättra den officiella dokumentationen
PHP har stor officiell dokumentation redan på http://php.net/manual/ . PHP Manual dokumenterar i stort sett alla språkfunktioner, kärnbibliotek och mest tillgängliga tillägg. Det finns många exempel att lära av. PHP-manualen finns på flera språk och format.
Det bästa av allt är att dokumentationen är gratis för alla att redigera .
PHP-dokumentationsteamet tillhandahåller en online-redigerare för PHP-manualen på https://edit.php.net . Den stöder flera tjänster med enkel inloggning, inklusive inloggning med ditt Stack Overflow-konto. Du hittar en introduktion till redaktören på https://wiki.php.net/doc/editor .
Ändringar i PHP-manualen måste godkännas av personer från PHP-dokumentationsteamet med Doc Karma . Doc Karma är något som rykte, men svårare att få. Denna peer review-process säkerställer att endast fakta korrekt information kommer in i PHP Manual.
PHP-handboken är skriven i DocBook, som är ett lättlära sig markeringsspråk för författarböcker. Det kan se lite komplicerat ut vid första anblicken, men det finns mallar för att komma igång. Du behöver verkligen inte vara en DocBook-expert för att bidra.
Tips för att bidra till manualen
Följande är en lista med tips för dig som vill bidra till PHP-manualen:
- Följ manualens stilriktlinjer . Se till att manualens stilriktlinjer alltid följs för konsekvensens skull.
- Utför stavnings- och grammatikontroller . Se till att rätt stavning och grammatik används - annars kan informationen som presenteras vara svårare att ansluta sig och innehållet ser mindre professionellt ut.
- Var spänd i förklaringarna . Undvik att rusa för att tydligt och tydligt presentera informationen för utvecklare som snabbt vill referera till den.
- Separera koden från dess utgång . Detta ger renare och mindre sammanhängande kodexempel för utvecklare att smälta.
- Kontrollera sidavsnittets ordning . Se till att alla delar av den manuella sidan som redigeras är i rätt ordning. Enhet i manualen gör det lättare att snabbt läsa och leta information.
- Ta bort PHP 4-relaterat innehåll . Specifika omnämnanden till PHP 4 är inte längre relevanta med tanke på hur gammal den är nu. Omnämnanden av den bör tas bort från bruksanvisningen för att förhindra att den omvandlas med onödig information.
- Korrekt version filer . När du skapar nya filer i dokumentationen, se till att filens reviderings-ID är inställt på ingenting, så som så:
<!-- $Revision$ -->. - Slå samman användbara kommentarer i manualen . Vissa kommentarer bidrar med användbar information som manualen kan dra nytta av. Dessa bör sammanfogas till huvudsidan.
- Bryt inte dokumentationen . Se alltid till att PHP-manualen bygger ordentligt innan du gör ändringarna.