| javadoc | |
|---|---|
| Típusú | Dokumentáció generátor |
| Fejlesztő | Sun Microsystems |
| Operációs rendszer | platformközi |
| Hardver platform | Java virtuális gép |
| legújabb verzió | 1.50 |
| Engedély | GNU GPL 2 + "Osztályút-kivétel" [1] |
| Weboldal | docs.oracle.com/javase/8… |
A Javadoc egy HTML dokumentáció generátor a Sun Microsystems Java forráskód megjegyzéseiből . A Javadoc egy szabvány a Java osztályok dokumentálására . A legtöbb szoftverfejlesztő környezet automatikusan létrehozza a HTML -dokumentációt a Javadoc használatával.
A Javadoc API -t is biztosít doclet -ek és taglet -ek létrehozásához , amelyek lehetővé teszik a programozó számára egy Java - alkalmazás szerkezetének elemzését .
A dokumentációs megjegyzések a következőkre szolgálnak:
A megjegyzésnek minden esetben a dokumentált elem elé kell kerülnie.
| Javadoc -leírók listája | ||
|---|---|---|
| Leíró | Leírás | Alkalmazható |
| @author | Szerző | osztály, felület |
| @version | Változat. Osztályonként legfeljebb egy leíró | osztály, felület |
| @since | Jelzi, hogy melyik verziótól érhető el | osztály, felület, mező, metódus |
| @see | Hivatkozás egy másik helyre a dokumentációban | osztály, felület, mező, metódus |
| @param | Módszer bemeneti paramétere | módszer |
| @return | Visszatérési érték leírása | módszer |
| @exception имякласса описание @throws имякласса описание |
A metódusból kidobható kivétel leírása | módszer |
| @deprecated | Az elavult kódblokkok leírása | osztály, felület, mező, metódus |
| {@link reference} | Link | osztály, felület, mező, metódus |
| {@value} | Változó érték leírása | statikus mező |
A következő leírók használhatók egy változó dokumentálására: @see, @serial, @serialField, {@value}, @elavult. Leírók használhatók osztályokhoz és interfészekhez: @see, @author, @deprecated, @param, @version. A módszerek dokumentálhatók a következő leírókkal: @see, @return, @param, @deprecated, @throws, @serialData, {@inheritDoc}, @excertion.
A {@link}, {@docRoot}, {@code}, {@literal}, @since, {@linkplain} leírók bárhol használhatók.
Példa Javadoc jelölés használatára egy metódus dokumentálására [2] . A változótípusokat nem kell megadni.
/** * <p>Ellenőrzi, hogy az áthelyezés érvényes-e.</p> * <p>Ha például az áthelyezést e2-e4-re szeretné beállítani, írja be az isValidMove(5,2,5,4); * A casting rögzítéséhez jelölje meg, hogy a király honnan és hová költözik. * Például fekete öntéshez írja be: isValidMove(5,8,7,8);</p> * * @param fromCol A függőleges, ahol a darab található (1=a, 8=h) * @param fromRow A vízszintes , amelyen az ábra található (1...8) * @param toCol A cella függőlegese, amelyen a mozgás történik (1=a, 8=h) * @param toRow A cella vízszintes, on amelyre a költözés megtörténik (1...8) * @ visszatér igaz, ha a lépés érvényes, hamis ha nem */ logikai érték isValidMove ( int fromCol , int fromRow , int toCol , int toRow ) { . . . }