Javadoc

De la Wikipedia, enciclopedia liberă.
Salt la navigare Salt la căutare

Javadoc este o aplicație inclusă în Sun Microsystems Java Development Kit , utilizată pentru generarea automată de documentație cod sursă scrisă în limbaj Java .

Istorie

JavaDoc s-a născut ca un instrument intern utilizat de cercetătorii Sun care lucrau la crearea limbajului Java și a bibliotecilor sale; cantitatea mare de surse i-a determinat pe unii membri ai echipei să creeze un program pentru generarea automată de documentație HTML . De fapt, acest format permite o navigare foarte eficientă și rapidă, este bine cunoscut de programatori și este ușor indexabil de către motoarele de căutare . Cu toate acestea, crearea și întreținerea unei astfel de mase de pagini web nu ar fi fost concepute fără ajutorul unui sistem automat: gândiți-vă doar la cantitatea de referințe încrucișate care există între clase ( moștenire între clase, semnături ale metodelor, referințe la pachet) doar pentru a numi câteva) și tipurile inevitabile întâlnite la scrierea documentației. Prin urmare, JavaDoc s-a născut pentru a permite programatorilor să introducă fragmente HTML în comentarii (deci ignorate de compilator): deja cu primele versiuni a fost posibilă inserarea descrierilor fiecărei clase și a metodelor sale, precum și semnificația parametrilor și a membrului variabile.

Pe măsură ce versiunile JavaDoc au progresat, a devenit mai sofisticat și mai bogat în caracteristici:

  • inserarea linkurilor, chiar și către JavaDocs-uri externe;
  • inserarea indicației @deprecated pentru a indica clase și / sau metode destinate să dispară în viitoarele versiuni ale software-ului;
  • opțiuni avansate de formatare;
  • posibilitatea de a crea propriile Doclets : extensii JavaDoc care vă permit să gestionați diferitele faze ale generării documentației după bunul plac

Doclets, în special, au permis altor producători de software și alți dezvoltatori (în special open source ) să creeze instrumente foarte diversificate:

Marele succes al JavaDoc se datorează posibilității de a crea cu ușurință documentație cu aspect profesional, foarte asemănătoare cu cea oficială, chiar de către începător, care învață să prețuiască un aspect deseori subestimat al programării, adică gestionarea documentelor conexe. programele lor. Fișierele HTML generate de docletul standard au, de fapt, aceeași organizare grafică și logică ca și documentația pe care Sun o oferă pentru API - urile pe care le distribuie.

Operațiune

Informațiile de bază despre pachetele, clasele, metodele și câmpurile generate automat pot fi îmbogățite cu detalii suplimentare prin intermediul „comentariilor JavaDoc”; acestea sunt încadrate între secvențele de caractere / ** și * / (de fapt sunt o formă specială de „comentariu cu mai multe linii”) și sunt adăugate la documentația elementului care le urmează. Ele pot conține fragmente de HTML și markere (sau etichete) unice pentru JavaDoc.

Lista de etichete JavaDoc:

Etichetă Descriere
@autor Numele dezvoltatorului.
@depreciat (vezi mai sus) indică faptul că elementul poate fi șters de o versiune ulterioară a software-ului.
@excepție Indică excepțiile aruncate de o metodă; cf. @ aruncări.
@legătură Creați un hyperlink către documentație locală sau resurse externe (de obicei internetul).
@param Definește parametrii unei metode. Obligatoriu pentru fiecare parametru.
@întoarcere Indică valorile returnate ale unei metode. Această etichetă nu trebuie utilizată pentru metodele sau constructorii care returnează nulitatea .
@daca este Indică o asociere cu o altă metodă sau clasă.
@de cand Indică când a fost adăugată o metodă la o clasă.
@ aruncări Indică excepțiile aruncate de o metodă. Sinonim pentru @exception introdus în Javadoc 1.2.
@versiune Indică numărul versiunii unei clase sau metode.

NB: Dacă doriți simbolul @ fără intenția de a crea o etichetă JavaDoc, puteți utiliza codul HTML & # 064; pentru a evita problemele de analiză.

linkuri externe

Adus de la „ https://it.wikipedia.org/w/index.php?title=Javadoc&oldid=99606740 ”