 dokumentowanie kodu PHP, jakies zalecenia, sugeste, rady? |
| dokumentowanie kodu PHP, jakies zalecenia, sugeste, rady? |
 
Post
#1
|
|
 Grupa: Zarejestrowani Postów: 358 Pomógł: 0 Dołączył: 3.07.2003 Skąd: Szczecin->niebuszewo->*(next to window) Ostrzeżenie: (0%) 
 |
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?? -------------------- Jeśli życie to kara to nieźle nabroiłem ;-)
|
 |
 
|
 |
|
Post
#2
|
|
 Grupa: Zarejestrowani Postów: 657 Pomógł: 2 Dołączył: 15.08.2003 Skąd: Łódź Ostrzeżenie: (0%)
|
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". -------------------- |
|
|
|
|
Post
#3
|
|
|
Grupa: Zarejestrowani Postów: 358 Pomógł: 0 Dołączył: 3.07.2003 Skąd: Szczecin->niebuszewo->*(next to window) Ostrzeżenie: (0%)
|
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 -------------------- Jeśli życie to kara to nieźle nabroiłem ;-)
|
|
|
|
|
Post
#4
|
|
|
Grupa: Zarejestrowani Postów: 657 Pomógł: 2 Dołączył: 15.08.2003 Skąd: Łódź Ostrzeżenie: (0%)
|
Mi dziala pierwszy... drugi zaraz naprawie
-------------------- |
|
|
|
|
Post
#5
|
|
 Grupa: Zarejestrowani Postów: 853 Pomógł: 25 Dołączył: 27.08.2003 Skąd: Katowice Ostrzeżenie: (0%)
|
www.phpdoc.org - coraz popularniejszy php Documentator
-------------------- "If debugging is the process of removing bugs, then programming must be the process of putting them in..."
sobstel.org |
|
|
|
|
Post
#6
|
|
|
Grupa: Zarejestrowani Postów: 358 Pomógł: 0 Dołączył: 3.07.2003 Skąd: Szczecin->niebuszewo->*(next to window) Ostrzeżenie: (0%)
|
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
-------------------- Jeśli życie to kara to nieźle nabroiłem ;-)
|
|
|
|
|
Post
#7
|
|
|
Administrator PHPedia.pl Grupa: Developerzy Postów: 1 102 Pomógł: 2 Dołączył: 14.09.2003 Ostrzeżenie: (0%)
|
Nie wyobrażam sobie pracy bez udokumentowanego kodu
 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 PHPDoc jest ciągle udoskonalany i dziala z php5. btw. miałem gdzieś zaczątek artykułu o tym  @Vee Mała autoreklama ? 
-------------------- |
|
|
|
|
Post
#8
|
|
 Developer Grupa: Moderatorzy Postów: 2 844 Pomógł: 20 Dołączył: 25.11.2003 Skąd: Olkusz |
Cytat(bela_666 @ 2005-03-03 11:07:35) btw. miałem gdzieś zaczątek artykułu o tym 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 |
|
|
|
|
Post
#9
|
|
 Grupa: Zarząd Postów: 2 277 Pomógł: 6 Dołączył: 27.12.2002 Skąd: Wołów/Wrocław |
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  (szczególnie jak sie zapozna z listą dostępnych znacznikówi i ich znaczeń)
-------------------- "Niezależnie od tego, jakie masz osiągnięcia, ktoś Ci pomaga..."
|
|
|
|
|
Post
#10
|
|
|
Administrator PHPedia.pl Grupa: Developerzy Postów: 1 102 Pomógł: 2 Dołączył: 14.09.2003 Ostrzeżenie: (0%)
|
@hwao nie sam zaczełem pisać
-------------------- |
|
|
|
 |
|
Aktualny czas: 21.08.2025 - 15:51 |
