Jak generować pliki HTML Javadoc w Eclipse?

165

Napisałem komentarze w stylu Javadoc, takie jak ten w kodzie mojego projektu:

/**
 * Description...
 *
 * @param ...
 * @return .....
 */

Jak mogę generować pliki Javadoc HTML za pomocą Eclipse IDE?

java eclipse javadoc

— JaneNY
źródło

odnieś to. learnjava-soa.blogspot.com/2015/06/…

— madhu

234

Project> Generate Javadoc....
W Javadoc command:polu wyszukaj plik javadoc.exe (zwykle w lokalizacji [ścieżka_do_katalogu_jdk] \ bin \ javadoc.exe ).
Zaznacz pole obok projektu / pakietu / pliku, dla którego tworzysz plik Javadoc.
W Destination:polu wyszukaj żądane miejsce docelowe (na przykład katalog główny bieżącego projektu).
Kliknij Finish.

Teraz powinieneś być w stanie znaleźć nowo wygenerowany plik Javadoc w folderze docelowym. Otwórz plik index.html .

— Renu P.
źródło

1

Czy trzeba zainstalować pakiet Java JDK? Mam zainstalowaną Javę i mogę tworzyć programy Java w Eclipse ... ale javadoc.exenie istnieje nigdzie na moim dysku!

— AlainD,

Stary, ale dla każdego, kto w przyszłości może być zdezorientowany, sprawdź, czy masz zainstalowany pakiet JDK, a nie JRE (które nie zawiera javadoc.exe w tej lokalizacji).

— omoshiroiii

9

To jest odpowiedź uzupełniająca związana z PO:

Łatwe i niezawodne rozwiązanie do dodawania komentarzy Javadocs w Eclipse:

Przejdź do Help> Eclipse Marketplace....
Znajdź „JAutodoc”.
Zainstaluj go i uruchom ponownie Eclipse.

Aby użyć tego narzędzia, kliknij prawym przyciskiem myszy klasę i kliknij JAutodoc.

— pioneerBhawna
źródło

7

AFAIK, JAutodoc nie generuje kodu HTML z istniejących komentarzy javadoc (o co chodzi w pytaniu), ale raczej pomaga generować komentarze javadoc.

— Amani Kilumanga

3

Odpowiedź nie jest związana z pytaniem, ale właśnie tego szukałem :)

— keya.

Eclipse pozwoli Ci wygenerować Javadocs: Project -> Generate Javadocs ...

— pongapundit

Spowoduje to tylko wygenerowanie javadoc, a nie html, o który chodzi.

— Ashish

5

Możesz również zrobić to z łatwością z linii poleceń.

Otwórz wiersz poleceń z folderu / pakietu.
Z wiersza poleceń uruchom:

javadoc YourClassName.java
Aby zbiorczo wygenerować dokumenty dla wielu klas:

javadoc * .java

— Sean Das
źródło

2

Aby szybko dodać Javadoc, użyj następującego skrótu:

Windows : alt+ shift+J

Mac : ⌘+ Alt+J

W zależności od wybranego kontekstu zostanie wydrukowany plik Javadoc. Aby utworzyć Javadoc napisany przez OP, wybierz odpowiednią metodę i naciśnij klawisze strzałek.

— Jacob van Lingen
źródło