| javadoc | |
|---|---|
| Tip de | Generator de documentație |
| Dezvoltator | Microsisteme solare |
| Sistem de operare | multiplatformă |
| Platformă hardware | Mașină virtuală Java |
| ultima versiune | 1,50 |
| Licență | GNU GPL 2 + „Excepție Classpath” [1] |
| Site-ul web | docs.oracle.com/javase/8… |
Javadoc este un generator de documentație HTML din comentariile codului sursă Java ale Sun Microsystems . Javadoc este un standard pentru documentarea claselor Java . Majoritatea mediilor de dezvoltare software generează automat documentație HTML folosind Javadoc.
Javadoc oferă, de asemenea, un API pentru crearea de doclete și etichete care permit programatorului să analizeze structura unei aplicații Java .
Comentariile de documentare sunt folosite pentru:
În fiecare caz, comentariul trebuie să apară înaintea elementului documentat.
| Lista de descriptori Javadoc | ||
|---|---|---|
| Descriptor | Descriere | Aplicabil la |
| @author | Autor | clasa, interfata |
| @version | Versiune. Nu mai mult de un descriptor per clasă | clasa, interfata |
| @since | Indică din ce versiune este disponibilă | clasă, interfață, câmp, metodă |
| @see | Link către un alt loc din documentație | clasă, interfață, câmp, metodă |
| @param | Parametrul de intrare al metodei | metodă |
| @return | Descrierea valorii returnate | metodă |
| @exception имякласса описание @throws имякласса описание |
Descrierea excepției care poate fi aruncată din metodă | metodă |
| @deprecated | Descrierea blocurilor de cod depreciate | clasă, interfață, câmp, metodă |
| {@link reference} | Legătură | clasă, interfață, câmp, metodă |
| {@value} | Descrierea valorii variabile | câmp static |
Următorii descriptori pot fi utilizați pentru a documenta o variabilă: @see, @serial, @serialField, {@value}, @deprecated. Descriptorii pot fi utilizați pentru clase și interfețe: @see, @author, @deprecated, @param, @version. Metodele pot fi documentate folosind descriptori: @see, @return, @param, @deprecated, @throws, @serialData, {@inheritDoc}, @excertion.
Descriptorii {@link}, {@docRoot}, {@code}, {@literal}, @since, {@linkplain} pot fi utilizați oriunde.
Un exemplu de utilizare a marcajului Javadoc pentru a documenta o metodă [2] . Tipurile de variabile nu trebuie specificate.
/** * <p>Verifică dacă mutarea este validă.</p> * <p>De exemplu, pentru a seta mutarea la e2-e4, scrieți isValidMove(5,2,5,4); * Pentru a înregistra roca, indicați de unde și de unde se mută regele. * De exemplu, pentru roca neagră scrieți isValidMove(5,8,7,8);</p> * * @param fromCol Verticala în care se află piesa (1=a, 8=h) * @param fromRow Orizontală , pe care se află figura (1...8) * @param toCol Verticala celulei, pe care se face mutarea (1=a, 8=h) * @param toRow Orizontala celulei, pe care se face mutarea (1...8) * @ returnează adevărat dacă mutarea este validă, fals dacă nu */ boolean isValidMove ( int dinCol , int dinRând , int cătreCol , int cătreRând ) { . . . }