×
Creating solutions

Ako vo vývojovom prostredí STS vygenerovať dokumentáciu HTML pre aplikáciu v jazyku Java

V tomto článku predstavím, ako vytvoriť dokumentáciu HTML z komentárov Javadoc vo vývojovom prostredí STS. Keďže vývojové prostredie STS je upravený Eclipse, uvedený postup by mal fungovať aj pre vývojové prostredie Eclipse.
Pre vytvorenie dokumentácie v jazyku HTML je potrebné v zdrojových súboroch používať komentáre typu javadoc. Pre vygenerovanie dokumentácie k projektu je potrebné kliknúť na menu Project / Generate Javadoc .... Následne sa zobrazí dialóg. Do poľa Javadoc command: je potrebné nalistovať cestu k súboru javadoc.exe (súbor je súčasťou JDK). V mojom prípade to je cesta C:\Coding\Java\jdk1.8.0_20\bin\javadoc.exe.
V okne Select types for which Javadoc will be generated: je potrebné zaškrtnúť projekt, pre ktorý bude vygenerovaná dokumentácia. V sekcii Use standard doclet v poli Destination: je potrebné zadať cestu, kde bude dokumentácia vygenerovaná. Po kliknutí na tlačidlo Next sa zobrazí ďalší dialóg.
V tomto dialógu sa do poľa Document title: zadá názov dokumentácie, zaškrtnú sa príslušné polia pre generovanie dokumentácie - môžu byť aj všetky a v okne Select referenced archives and projects to which links should be generated: opäť označíme knižnicu alebo projekt, ktorý bude súčasťou dokumentácie. Opäť stlačíme tlačidlo Next a zaškrtneme Open generated index file in browser.
Po stlačení tlačidla Finish sa zobrazí vygenerovaná dokumentácia v predvolenom internetovom prehliadači.

Záver

Verím, že vám tento stručný návod ukázal, ako možno rýchlo vytvoriť dokumentáciu k Java aplikácii.


Softvér,Javadoc,IDE,Eclipse,STS,HTML
No part of this article may be reproduced without mention of the author and URL to this website.
For more information, see the About section.

Comments

Article has no comments.

Add a comment

Name (required)
Website
Message (required)
Submit
From latest