16-os előadás

Question 1

Javadoc mit csinál, mire való, miért használjuk?

Answer 1

A Javadoc eszköz egy program, amely forrásfájlokat és osztályfájlokat olvas be, majd azokat egy olyan formába alakítja, amelyet egy bővíthető háttérkomponens, az úgynevezett doclet, elemezni tud.

Question 2

Javadoc eszköz használata esetén a fő leírást hova írják? Milyen elemekhez adhat meg dokumentációt?

Answer 2

A Javadoc eszköz használata során a fő leírást az osztály, interfész, package, modul vagy metódus fölé közvetlenül írjuk. (modul, package, class, interface, constructor, method, enum member, field) /**így kell megadni*/

Question 3

A metódus dokumentációjának (javadoc) mik a kötelező elemei? Magyarázza az egyes elemeket?

Answer 3

main description
@param: Ha generikus típusokat használ, mindegyikhez meg kell adni egy leírást.
@return: Ha nem void akkor a return értéke.
@param: Formális paraméterek.
@throws: Minden kivételtípushoz, amely a throws deklarációban szerepel, ha vannak. Leírás, hogy milyen körülmények között dobhat kivételt.

Question 4

A metódus dokumentációjának kötelező elemein kívül soroljon fel és magyarázzon 5 standard tag-et (javadoc)!

Answer 4

@see: Más osztályokra, metódusokra vagy dokumentációkra hivatkozik.
@since: Melyik verzióban került be az adott elem.
@deprecated: Az adott elem elavult, alternatív megoldás.
@author: Az elem fejlesztőjének vagy fejlesztőinek neve.
@version: Az adott elem verziószámát adja meg