Ako vytvoriť Javadoc Pri komentovanie

Javadoc je de facto štandardom pre generovanie dokumentácie zo zdrojového kódu . Je to nástroj pre vytváranie HTML dokumentáciu zo špeciálne formátované komentáre v kóde v jazyku Java . To môže byť použitý na vytvorenie štruktúrovanej rozhranie pre programovanie aplikácií ( API ) dokumentácia automaticky , dať nejaké tipy na IDE alebo pre udelenie balíčkov , tried a metód . V podstate je to spôsob , ako komentuje popis parametrov , ktorý napísal , čo a kto na vine , ak sa zlomí . Java je dodávaný s príkazového riadku programu javadoc pre generovanie dokumentácie vo formáte HTML , ale väčšina Java integrované vývojové prostredie ( IDES ) majú tiež tento integrovaný . Pokyny dovolená 1

Vytvorte špeciálny Javadoc komentáre . Naznačovať javadoc komentár , spustite komentár s /** . Javadoc komentáre zvyčajne existujú v hornej časti súboru , pred triedach a pred metód . Vzhľadom k tomu , že je navrhnutý pre dokumentáciu pôvodného API , to nie je nezvyčajné , že vidí súborov s viac Javadoc komentárov ako kódu . " " /*** To je javadoc komentár . To nemá žiadne javadoc meta - tagy ešte , ale to vyvolať javadoc analyzátor sa pozrieť na tento komentár . * /" "
2

Pridať API meta - tagy ( štítky , ktoré popisujú API sám ) pri komentovanie . Tagy API sú názvy parametrov , popisy , výnimka profily , popisy návrat hodnoty , názvy metód a popisy metóda . Mnoho IDE začleniť tieto dáta do svoje tipy nástrojov a ďalších pomocníkov , rovnako ako to , že pre použitie v HTML alebo komentár formulára .
3

Použite opis metódy . Táto meta - tag nemá žiadny názov značky : Je to proste komentár , ktorý prichádza pred ostatnými značkami " " /*** Vypočíta sklon riadku .. * /" "
4

začleniť popisy parametrov . Tie sú označené na @ param meta - tagy, ktoré by mali byť , po ktorej nasleduje názov parametra a popis . " " /*** Vypočíta sklon riadku . ** @ Param p1 Prvý bod , ktorý opisuje riadku * @ param p2 Druhý bod , ktorý opisuje riadku * /" "
5

Späť popisy hodnôt . To je označované meta - tag @ návrate a by mala nasledovať opis návratovej hodnoty . " " /*** Vypočíta sklon riadku . ** @ Param p1 Prvý bod , ktorý opisuje riadku * @ param p2 Druhý bod , ktorý opisuje riadku * @ return sklon priamky ako float * /" "
6

Pridať kompetenciách tagy . Tagy atribút kód určitého autora . " " /*** Vypočíta sklon riadku . ** @ Autor Jack Smith * @ param p1 Prvý bod , ktorý opisuje riadku * @ param p2 Druhý bod , ktorý opisuje riadku * @ return sklon priamky ako float * /" "
7

generovanie dokumentácie vo formáte HTML . Ak si nie ste používate IDE alebo si len chcete urobiť ručne , môžete spustiť príkazový riadok programu javadoc z adresára projektu . Zadajte výstupný adresár s - d prepínače a odovzdať mu zoznam . Java súbory ( obvykle ako zástupný znak ) . " " Javadoc - d docs * . Java " , "

• Predchádzajúca strana: Ako nainštalovať Javu 
• Ďalšia strana: Ako zanechať komentár v kóde v jazyku Java