W temacie javadoców chyba ciężko o wielkie fajerwerki. Ciężko mi powiedzieć tak naprawde,
co mi sie w tym podoba, a co mi sie nie podoba- nie używałem tego do tej pory. Tym niemniej
pare rzeczy mi się nasunęło(szkoda, że to głównie ogólniki):
-fajna jest sam pomysł automatycznego generowania dokumentacji, nie trzeba się martwić
o jakieś układ stron, formę graficzną itd.
-ułatwiają komunikacje pomiedzy programistami- nie trzeba szukac wszystkiego w kodzie, tylko
można wygenerować dokumentacje i w wygodny sposób poszukać czegoś tam, ma się klasę, metody
i ich opisy w jednym miejscu, można abstrahować od kodu
-można jakoś modyfikować wygląd naszej dokumentacji (można podać css, na którego podstawie
ma być wygenerowana dokumentacja)
Co mi sie nie podoba(a przynajmniej co mogłoby być w jakiś sposób poprawione):
-dokumentacja tylko jako html(pdf, ps i inne takie rzeczy chyba były jakoś testowane, ale zdaje
się, że jeszcze nie do końca działają)
-nie można dokumentować treści metod
To co wg mnie należaloby powiedzieć:
-co dokładnie generuje javadoc(liste pakietów z klasami, hierarchie klas i zależności miedzy nimi
opis klas, pakietów, metod, przestarzałe metody, indeks)
-może coś o docletach(co to jest; że można napisac własny; jak używać niestandardowych docletów)
-jak korzystać z javadoc(tzn. gdzie i jak to umieszczać w kodzie; znaczniki- co to, jakie są
i co znaczą)
-jak uruchomić javadoc(tzn juz samo tworzenie dokumentacji) w eclipse(tam jest łatwo) NetBeansie
(tu nie wiem), coś o opcjach(public, protected, private itd.)
To by było na tyle, moze nie jest tego jakos strasznie duzo, ale na 15 minut na pewno wystarczy,
a chyba więcej ciężko byłoby wymyslić.
pozdro
co mi sie w tym podoba, a co mi sie nie podoba- nie używałem tego do tej pory. Tym niemniej
pare rzeczy mi się nasunęło(szkoda, że to głównie ogólniki):
-fajna jest sam pomysł automatycznego generowania dokumentacji, nie trzeba się martwić
o jakieś układ stron, formę graficzną itd.
-ułatwiają komunikacje pomiedzy programistami- nie trzeba szukac wszystkiego w kodzie, tylko
można wygenerować dokumentacje i w wygodny sposób poszukać czegoś tam, ma się klasę, metody
i ich opisy w jednym miejscu, można abstrahować od kodu
-można jakoś modyfikować wygląd naszej dokumentacji (można podać css, na którego podstawie
ma być wygenerowana dokumentacja)
Co mi sie nie podoba(a przynajmniej co mogłoby być w jakiś sposób poprawione):
-dokumentacja tylko jako html(pdf, ps i inne takie rzeczy chyba były jakoś testowane, ale zdaje
się, że jeszcze nie do końca działają)
-nie można dokumentować treści metod
To co wg mnie należaloby powiedzieć:
-co dokładnie generuje javadoc(liste pakietów z klasami, hierarchie klas i zależności miedzy nimi
opis klas, pakietów, metod, przestarzałe metody, indeks)
-może coś o docletach(co to jest; że można napisac własny; jak używać niestandardowych docletów)
-jak korzystać z javadoc(tzn. gdzie i jak to umieszczać w kodzie; znaczniki- co to, jakie są
i co znaczą)
-jak uruchomić javadoc(tzn juz samo tworzenie dokumentacji) w eclipse(tam jest łatwo) NetBeansie
(tu nie wiem), coś o opcjach(public, protected, private itd.)
To by było na tyle, moze nie jest tego jakos strasznie duzo, ale na 15 minut na pewno wystarczy,
a chyba więcej ciężko byłoby wymyslić.
pozdro