Obsah:

Ako napíšete Javadoc?
Ako napíšete Javadoc?

Video: Ako napíšete Javadoc?

Video: Ako napíšete Javadoc?
Video: Intro to JavaDoc - 1 of 2 2024, November
Anonim

Štandard kódovania Javadoc

  1. Napíšte Javadoc čítať ako zdrojový kód.
  2. Verejné a chránené.
  3. Použite štandardný štýl pre Javadoc komentovať.
  4. Používajte jednoduché značky HTML, nie platný XHTML.
  5. Použite jeden

    tag medzi odsekmi.

  6. Použite jeden
  7. tag pre položky v zozname.
  8. Definujte pútavú prvú vetu.

Ako v tomto smere vytvoríte Javadoc?

poskytnúť verziu triedy, rozhrania alebo enum. Vyberte „Generovať JavaDoc ” z ponuky Projekt a zobrazí sa sprievodca. Zadajte umiestnenie pre JavaDoc súbor na vašom počítači, predvolene bude na jednotke C. Vyberte projekt a potom balíky, pre ktoré chcete vytvoriť JavaDoc súbor.

Následne je otázkou, čo sú javadocs a kedy by sa mali používať? Javadoc je nástroj, ktorý sa dodáva s JDK a je použité na generovanie dokumentácie kódu Java vo formáte HTML zo zdrojového kódu Java, ktorý vyžaduje dokumentáciu vo vopred definovanom formáte. */ sú viacriadkové komentáre Java. Podobne riadok, ktorý // predchádza, je jednoriadkový komentár Java.

Vzhľadom na to, čo je príkaz Javadoc?

javadoc je a príkaz -line nástroj na extrahovanie špeciálnych komentárov (nazývaných komentáre doc) zo zdrojových súborov java a generovanie ľahko použiteľného stromu HTML súborov, ktorý ich obsahuje. Komentáre môžu obsahovať štandardné HTML značky a javadoc @tags. Špecifikácia Java API je príkladom toho javadoc vyrába.

Ako otvorím súbor Javadoc?

Ak chcete nájsť Javadoc , prejdite do priečinka Používateľ (v systéme Windows 7 je to C:Users*Používateľské meno*), potom prejdite do priečinka sunspotfrcsdk/doc/ javadoc . Dvakrát kliknite na index. html súbor do otvorené vo vašom predvolenom webovom prehliadači.

Odporúča: