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

Odpowiedzi:

234

  1. Project> Generate Javadoc....

  2. W Javadoc command:polu wyszukaj plik javadoc.exe (zwykle w lokalizacji [ścieżka_do_katalogu_jdk] \ bin \ javadoc.exe ).

  3. Zaznacz pole obok projektu / pakietu / pliku, dla którego tworzysz plik Javadoc.

  4. W Destination:polu wyszukaj żądane miejsce docelowe (na przykład katalog główny bieżącego projektu).

  5. 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:

  1. Przejdź do Help> Eclipse Marketplace....
  2. Znajdź „JAutodoc”.
  3. 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ń.

  1. Otwórz wiersz poleceń z folderu / pakietu.

  2. Z wiersza poleceń uruchom:

    javadoc YourClassName.java

  3. 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