Atunci când documentarea aplicației este de asemenea necesar program de documentare de sprijin. Dacă documentația și codul sunt separate, a creat din greșeală dificultăți legate de necesitatea modificării secțiunilor relevante ale documentației atunci când modificați codul.
Pentru a documenta codul, puteți utiliza tag-uri HTML. Când se utilizează descriptori de referință @see și @link, întâi trebuie să specificați numele clasei, iar după simbolul „#“ metoda sau câmpul său.
mediu de dezvoltare IDE ajută de obicei programator „cu iluminare din spate“ documentație încorporată. Următoarele date sunt capturi de ecran IDE Eclipse ferestre pop-up.
utilitate javadoc ca intrare primește un fișier cu codul sursă al programului pentru care este generat fișierul NTML. Documentația pentru fiecare clasă într-un fișier separat NTML. În plus, aceasta creează copac indicele și ierarhia. Acesta poate fi generat și alte fișiere NTML.
Pentru a crea documente, puteți utiliza furnica.
Exemplu de scenariu (sarcini) ant pentru formare Documente aplicare MyProject:
Detalii privind formarea documentației prezentate la Javadoc / pagina Javadoc2