| javadoc | |
|---|---|
| Typ | Generátor dokumentace |
| Vývojář | Sun Microsystems |
| Operační systém | multiplatformní |
| Hardwarová platforma | Java virtuální stroj |
| Nejnovější verze | 1,50 |
| Licence | GNU GPL 2 + "Výjimka Classpath" [1] |
| webová stránka | docs.oracle.com/javase/8… |
Javadoc je generátor HTML dokumentace z komentářů ke zdrojovému kódu Java společnosti Sun Microsystems . Javadoc je standard pro dokumentaci tříd Java . Většina prostředí pro vývoj softwaru automaticky generuje HTML dokumentaci pomocí Javadoc.
Javadoc také poskytuje API pro vytváření docletů a tagletů , které umožňují programátorovi analyzovat strukturu Java aplikace.
Komentáře k dokumentaci se používají pro:
V každém případě musí komentář předcházet dokumentovanému prvku.
| Seznam Javadoc deskriptorů | ||
|---|---|---|
| Deskriptor | Popis | Použitelné pro |
| @author | Autor | třída, rozhraní |
| @version | Verze. Ne více než jeden deskriptor na třídu | třída, rozhraní |
| @since | Označuje, od které verze je k dispozici | třída, rozhraní, pole, metoda |
| @see | Odkaz na jiné místo v dokumentaci | třída, rozhraní, pole, metoda |
| @param | Vstupní parametr metody | metoda |
| @return | Popis návratové hodnoty | metoda |
| @exception имякласса описание @throws имякласса описание |
Popis výjimky, kterou lze z metody vyvolat | metoda |
| @deprecated | Popis zastaralých bloků kódu | třída, rozhraní, pole, metoda |
| {@link reference} | Odkaz | třída, rozhraní, pole, metoda |
| {@value} | Popis proměnné hodnoty | statické pole |
K dokumentaci proměnné lze použít následující deskriptory: @see, @serial, @serialField, {@value}, @deprecated. Deskriptory lze použít pro třídy a rozhraní: @see, @author, @deprecated, @param, @version. Metody lze dokumentovat pomocí deskriptorů: @see, @return, @param, @deprecated, @throws, @serialData, {@inheritDoc}, @excertion.
Deskriptory {@link}, {@docRoot}, {@code}, {@literal}, @since, {@linkplain} lze použít kdekoli.
Příklad použití značek Javadoc k dokumentaci metody [2] . Typy proměnných není třeba specifikovat.
/** * <p>Zkontroluje, zda je tah platný.</p> * <p>Například pro nastavení tahu na e2-e4 napište isValidMove(5,2,5,4); * Chcete-li zaznamenat rošádu, uveďte, odkud a odkud se král pohybuje. * Například pro rošádu černé napište isValidMove(5,8,7,8);</p> * * @param fromCol Vertikální, kde se figurka nachází (1=a, 8=h) * @param fromRow Horizontální , na kterém je obrázek umístěn (1...8) * @param toCol Vertikál buňky, na které se provádí tah (1=a, 8=h) * @param toRow Horizontální rovina buňky, na kterým se tah provede (1...8) * @ return true, pokud je tah platný, false, pokud ne */ boolean isValidMove ( int fromCol , int fromRow , int toCol , int toRow ) { . . . }