Pomoc - Szukaj - Użytkownicy - Kalendarz
Pełna wersja: Skrypt dokumentacji
Forum PHP.pl > Inne > Hydepark
daniel1302
Witam, mam pytanie jakich używacie aplikacji do opisywania(tworzenia dokumentacji skryptów PHP. Niechodzi mi o rysowanie wykresów UML, ale o opisywanie funkcji jak np php.net.pl.
Znam skrypt PHPDocumentator ale chce sam tworzyc dokumentacje a nie na podstawie kodu.
Zyx
http://www.invenzzia.org/en/projects/typefriendly

Ściągasz, instalujesz, piszesz.
daniel1302
Tylko jak to moge zainstalować na serwerze bez dostępu do lini poleceń?
Zyx
A po co ty to na serwerze chcesz instalować? Dokumentacje się generuje na lokalnym komputerze, a na serwer wysyła gotowe pliki HTML. I dokładnie tak samo jest to na php.net zrobione. Dokumentacja napisana jest w DocBooku, co jakiś czas jest generowany nowy zrzut do HTML-a i podpinany na stronkę, tyle że w DocBooku samo wykonanie struktury dokumentacji jest znacznie trudniejsze, o generowaniu HTML-a z tego nie wspominając... przynajmniej jeśli mówimy o takim poziomie, jaki prezentuje php.net.

Jeśli chcesz dać możliwość robienia komentarzy, po prostu napisz sobie do TF własny system wyjścia, który z informacji o podstronach zrobi po prostu plik SQL. W wersji 0.2. główna funkcjonalność będzie dostępna już w postaci biblioteki, więc powinno to być jeszcze łatwiejsze.
daniel1302
Ok dzięki. Myślałem, że dokumentacja jest generowana na realu czyli w chwili odwiedzenia strony.
To jest wersja lo-fi głównej zawartości. Aby zobaczyć pełną wersję z większą zawartością, obrazkami i formatowaniem proszę kliknij tutaj.
Invision Power Board © 2001-2025 Invision Power Services, Inc.