PHP
Wkład w podręcznik PHP
Szukaj…
Wprowadzenie
Podręcznik PHP zawiera zarówno odniesienie funkcjonalne, jak i odniesienie językowe wraz z objaśnieniami głównych funkcji PHP. Podręcznik PHP, w przeciwieństwie do dokumentacji większości języków, zachęca programistów PHP do dodawania własnych przykładów i notatek do każdej strony dokumentacji. W tym temacie wyjaśniono wkład do podręcznika PHP, a także wskazówki, porady i wskazówki dotyczące najlepszych praktyk.
Uwagi
Treści w tym temacie powinny głównie opisywać proces tworzenia podręcznika PHP, np. Wyjaśniać, jak dodawać strony, jak przesyłać je do recenzji, znajdowanie obszarów, w których można dodawać treści, itd.
Popraw oficjalną dokumentację
PHP ma świetną oficjalną dokumentację już na stronie http://php.net/manual/ . Podręcznik PHP dokumentuje prawie wszystkie funkcje językowe, podstawowe biblioteki i większość dostępnych rozszerzeń. Jest wiele przykładów do nauki. Podręcznik PHP jest dostępny w wielu językach i formatach.
Co najważniejsze, dokumentacja jest bezpłatna dla każdego do edycji .
Zespół dokumentacji PHP udostępnia edytor online Podręcznika PHP pod adresem https://edit.php.net . Obsługuje wiele usług rejestracji jednokrotnej, w tym logowanie się przy użyciu konta przepełnienia stosu. Wprowadzenie do edytora można znaleźć na stronie https://wiki.php.net/doc/editor .
Zmiany w Podręczniku PHP muszą być zatwierdzone przez osoby z Zespołu dokumentacji PHP posiadające Doc Karmę . Doktor Karma przypomina nieco reputację, ale trudniej ją zdobyć. Ten proces wzajemnej oceny zapewnia, że tylko poprawne pod względem faktycznym informacje dostaną się do Podręcznika PHP.
Podręcznik PHP został napisany w DocBook, który jest łatwym do nauczenia się językiem znaczników do tworzenia książek. Na pierwszy rzut oka może się to wydawać trochę skomplikowane, ale istnieją szablony na początek. Na pewno nie musisz być ekspertem DocBook, aby wnieść swój wkład.
Wskazówki dotyczące wkładu do instrukcji
Poniżej znajduje się lista wskazówek dla tych, którzy chcą przyczynić się do instrukcji PHP:
- Postępuj zgodnie ze wskazówkami dotyczącymi stylu instrukcji . Aby zachować spójność, należy zawsze przestrzegać wskazówek zawartych w instrukcji obsługi .
- Wykonaj sprawdzanie pisowni i gramatyki . Upewnij się, że używana jest poprawna pisownia i gramatyka - w przeciwnym razie przedstawione informacje mogą być trudniejsze do przyswojenia, a treść będzie wyglądać mniej profesjonalnie.
- Bądź zwięzły w wyjaśnieniach . Unikaj wędrowania w celu jasnego i zwięzłego przedstawiania informacji programistom, którzy chcą szybko do nich sięgnąć.
- Oddziel kod od jego wyniku . Daje to czystszym i mniej skomplikowanym przykładom kodu do zrozumienia przez programistów.
- Sprawdź kolejność sekcji strony . Upewnij się, że wszystkie sekcje edytowanej strony podręcznika są w odpowiedniej kolejności. Jednorodność instrukcji ułatwia szybkie czytanie i wyszukiwanie informacji.
- Usuń zawartość związaną z PHP 4 . Konkretne wzmianki o PHP 4 nie są już istotne, biorąc pod uwagę wiek, jaki ma teraz. Wzmianki o nim powinny zostać usunięte z podręcznika, aby uniknąć splotu niepotrzebnych informacji.
- Pliki w odpowiedniej wersji . Tworząc nowe pliki w dokumentacji, upewnij się, że identyfikator wersji pliku jest ustawiony na nic, na przykład:
<!-- $Revision$ -->. - Połącz przydatne komentarze z instrukcją . Niektóre komentarze dostarczają użytecznych informacji, z których może skorzystać instrukcja. Powinny zostać połączone z treścią strony głównej.
- Nie psuj kompilacji dokumentacji . Zawsze upewnij się, że instrukcja PHP buduje się poprawnie przed zatwierdzeniem zmian.