post_ico4

Dokumentowanie projektu – cz. II

W tej części artykułu zaprezentuję w jaki sposób wygenerować dokumentację projektu za pomocą PHPDoc.

Instalacja

Najłatwiej możemy zainstalować korzystając z repozytorium PEAR. W wierszu poleceń systemu operacyjnego wystarczy wpisać:

pear install PhpDocumentor

Użycie

Aby sprawdzić czy wszystko zostało poprawnie zostało zainstalowane wpisujemy:

phpdoc

Powinniśmy otrzymać komunikat podobny do poniższego:

PHP Version 5.3.3-7+squeeze3

phpDocumentor version 1.4.3

Parsing configuration file phpDocumentor.ini...

   (found in /usr/share/php/data/PhpDocumentor/)...

done

Żeby wygenerować dokumentację na podstawie komentarzy PHPDoc wpisujemy w wierszu:

phpdoc -o HTML:frames:earthli -d /sciezka/do/projektu/z/kodem -t /sciezka/do/celowa/dokumentacji -ti „Tytuł dokumentacji”

Opis poszczególnych opcji:

  • -o – wybór systemu wyjścia.
  • -d – katalog lub lista katalogów do przetworzenia.
  • -t – katalog, gdzie pojawi się wygenerowana dokumentacja.
  • -ti – tytuł dokumentacji (domyślnie: „Generated documentation”).

Jeżeli proces przebiegł prawidłowo (w wierszu poleceń powinny pokazywać się różne komunikaty) po kilku sekundach dokumentacja (w postaci kodu HTML) powinna być wygenerowana we wskazanym miejscu.

Zakończenie

Artykuł ten pokazuje tylko podstawy użycia PHPDoc. Jest to bardzo przydatne narzędzie przy pracy nad aplikacjami zawierającymi wiele linii kodu. Na stronie projektu znajduje się obszerna dokumentacja, która w przystępny sposób opisuje jak wykorzystać całą potęgę tego mechanizmu.

Powiązane tematy

Co sądzisz o wpisie?
BeżnadziejnySłabyŚredniDobryBardzo dobry (Brak ocen, bądź pierwszy!)
Loading...