Pomoc - Szukaj - Użytkownicy - Kalendarz
Pełna wersja: dokumentowanie kodu PHP
Forum PHP.pl > Forum > PHP > Pro > Archiwum Pro
squid
Coraz czesciej pracuje sie w grupach czesto zmieniaja sie sklay istnieje potrzeba dokumentowania kodu chocby w sposob podstawowy, slyszalem o PEAR::PHPdoc wzorowany na podobnym narzedziu Javy, czy istnieja jakies inne techniki dokumentacji kodu w sposob mniej lub bardziej automatyczny? Jesli ktos uzywalPHPdoc'a to moze podzieli sie spostrzezeniami i uwagami na emat tego narzedzi. bede bardzo wdzieczny ,mysle ze nie tylko mi sie przyda.

Jest jeszcze jedno co mnie trapi odnoscnie PHPdoc's mianowicie jest to narzedzie, ktore powastalo w czasach PHP4 czy w takim razie umozliwaia dokumentacji interfejsow i klas abstrakcyjnych w PHP5??
Vengeance
Zapraszam do http://forum.php.pl/index.php?showtopic=26844

jest tam kod mojego jeszcze nie skończonego frameworka w całości w php5. Dodatkowo jest także wygenerowana dokumentacja phpDoc-a.
Możesz sobie sprawdzić naocznie jako to jest z tym "radzeniem sobie".
squid
Cytat(Vengeance @ 2005-03-02 23:24:22)
Zapraszam do http://forum.php.pl/index.php?showtopic=26844

jest tam kod mojego jeszcze nie skończonego frameworka w całości w php5. Dodatkowo jest także wygenerowana dokumentacja phpDoc-a.
Możesz sobie sprawdzić naocznie jako to jest z tym "radzeniem sobie".

nie wiem czy to chwilowe czy tez nie ale linki do kodu z tamtego temtu nie dzialaja
Vengeance
Mi dziala pierwszy... drugi zaraz naprawie
sobstel
www.phpdoc.org - coraz popularniejszy php Documentator
squid
jest tez www.phpdos.de i pakiet PEAR o nazwie PHPdoc, czy wszystkie te PHPdoc'e to to samo czy sie roznia, sprawdzalem ten z PEAR i ze strony www.phpdos.de i sa podobne ale maja troche zminiona strukture katalogow co sprawia ze przyklady dla jednego nie dzialaja przy uzyciu drugiego
bela
Nie wyobrażam sobie pracy bez udokumentowanego kodu smile.gif
W samodzielnych projektach to się przydaje, jednak w grupowych jest to niezbędne. Bez dokumentacji trzeba analizować kod, a tak to sobie patrzysz w opis i juz smile.gif

PHPDoc jest ciągle udoskonalany i dziala z php5.

btw. miałem gdzieś zaczątek artykułu o tym dry.gif

@Vee Mała autoreklama ? biggrin.gif
hwao
Cytat(bela_666 @ 2005-03-03 11:07:35)
btw. miałem gdzieś zaczątek artykułu o tym dry.gif

http://webcity.pl/webcity/artykuly.php/t/48 ?

Co do dokumentowania to dla php nie ma nic lepszego od phpDocumentor i kazdy kod jaki pisze "zaopatruje" w jego znaczniki.

Jednak dlamnie niektore sa poprostu nie przydatne :-) bo widac na 1 rzut oka co i jak.

Co prawda do prawad w pracach grupowych takie cos jest niezbedne bo inaczej totalne "pogubienie" sie wkrada, projekty solo to juz roznie :-) chyba ze chcesz potem kod udostepniac.

Osobiscie nie kozystam z tego co generuje phpDocumentor ale komentarze w kodzie sie przydaja
DeyV
Aby ułatwić sobie naukę pisania komentarzy, warto zaopatrzyć się (przynajmniej na te kilkadziesiąt darmowych dni) w edytor Zend 4.0
Program ten świetnie wspiera programistę w pisaniu komentarzy, pokazuje również prawdziwą wartość tych komentarzy, "na żywo" wykorzystując je i podpowiadając programiście.
Co więcej - ma zintegrowanego phpDocumentor'a, pozwalając przy pomocy paru kliknieć wygenerować dokumentację.
I choć ja, podobnie jak hwao, żadko przeglądam wygenerowaną w ten sposób dokumentację, to jednak kod bez tego typu komentarzy jest w tej chwili dla mnie zupełnie nieczytelny.

Tak więc - http://www.phpdoc.org/ i nic więcej nie jest potrzebne winksmiley.jpg (szczególnie jak sie zapozna z listą dostępnych znacznikówi i ich znaczeń)
bela
@hwao nie sam zaczełem pisać winksmiley.jpg
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.