Kreator
Generowanie dokumentacj Javadoc umożliwia wygenerowanie dokumentacji Javadoc. Jest to interfejs użytkownika narzędzia javadoc.exe dostępny w zestawie JDK Java.
Pełną dokumentację narzędzia Javadoc można znaleźć na stronie Narzędzie Javadoc firmy Sun.
Wybór typu:
Opcja |
Opis |
---|---|
Wybierz typy, dla których ma być generowana dokumentacja Javadoc |
Na tej liście należy zaznaczyć lub usunąć zaznaczenie odpowiednich pól w celu dokładnego określenia typów, które mają być wyeksportowane do pliku JAR. Ta lista jest inicjowana przez środowisko robocze. W danej chwili może być wybrany tylko jeden projekt, ponieważ narzędzie Javadoc może korzystać tylko z jednej ścieżki klasy projektu. |
Utwórz dokumentację Javadoc dla składowych z widocznością |
|
Użyj standardowej biblioteki Doclet |
Powoduje uruchomienie komendy narzędzia Javadoc przy użyciu standardowej biblioteki Doclet (wartość domyślna).
|
Użyj niestandardowej biblioteki Doclet |
Umożliwia wygenerowanie dokumentacji za pomocą niestandardowej biblioteki Doclet.
|
Argumenty standardowej biblioteki Doclet (dostępne po wybraniu opcji Użyj standardowej biblioteki Doclet):
Opcja |
Opis |
---|---|
Tytuł dokumentu |
Umożliwia określenie tytułu dokumentu. |
Generuj stronę używania | Tę opcję należy wybrać, jeśli dokumentacja ma zawierać stronę Użycie. |
Generuj drzewo hierarchii | Tę opcję należy wybrać, jeśli dokumentacja ma zawierać stronę Drzewo. |
Generuj pasek nawigatora |
Tę opcję należy wybrać, jeśli dokumentacja ma zawierać pasek nawigacji (nagłówek i stopkę). |
Wygeneruj indeks | Tę opcję należy wybrać, jeśli dokumentacja ma zawierać stronę Indeks. |
Generuj indeks dla każdej litery | Umożliwia utworzenie indeksu dla każdej litery. Ta opcja jest włączona, jeśli wybrano opcję Generuj indeks. |
@author | Tę opcję należy wybrać, jeśli dokumentacja ma zawierać znacznik @author. |
@version | Tę opcję należy wybrać, jeśli dokumentacja ma zawierać znacznik @version. |
@deprecated | Tę opcję należy wybrać, jeśli dokumentacja ma zawierać znacznik @deprecated. |
lista nieaktualnych | Tę opcję należy wybrać, jeśli dokumentacja ma zawierać stronę Nieaktualne. Ta opcja jest włączona, jeśli wybrano opcję @deprecated. |
Wybierz przywoływane klasy, do których mają zostać utworzone odsyłacze w dokumentacji Javadoc |
Umożliwia określenie innych dokumentów, do których mają zostać utworzone odsyłacze w dokumentacji Javadoc w przypadku odwołań do innych typów.
|
Arkusz stylów | Umożliwia wybór arkusza stylów, który ma być użyty. |
Ogólne opcje dokumentacji Javadoc:
Opcja |
Opis |
---|---|
Przegląd |
Określa, że narzędzie Javadoc powinno pobrać tekst streszczenia dokumentacji z podanego pliku. Tekst ten zostanie umieszczony w pliku overview-summary.html. |
Dodatkowe opcje dokumentacji Javadoc |
W tym miejscu można dodać dowolną liczbę opcji dodatkowych, takich jak: opcje niestandardowej biblioteki Doclet, opcje maszyny VM lub opcje zgodności ze środowiskiem JRE 1.4. |
Zapisz ustawienia tego eksportu dokumentacji Javadoc jako skrypt Ant |
Umożliwia zapisanie skryptu Ant, który wykona określony eksport dokumentacji Javadoc bez konieczności użycia kreatora. Istniejący skrypt Ant można zmodyfikować za pomocą tego kreatora (należy użyć opcji Otwórz kreatora dokumentacji Javadoc z menu kontekstowego wygenerowanego skryptu Ant). |
Otwórz wygenerowany plik indeksu w przeglądarce | Otwiera wygenerowany plik index.html w przeglądarce (opcja dostępna tylko w przypadku użycia standardowej biblioteki Doclet). |
Aby rozpocząć generowanie dokumentacji Javadoc, należy nacisnąć przycisk Zakończ. Jeśli miejsce docelowe różni się od położenia skonfigurowanego na stronie Położenie dokumentacji Javadoc projektu, zostanie wyświetlone pytanie, czy nowy folder docelowy ma zostać ustawiony jako położenie dokumentacji Javadoc projektu. Twierdząca odpowiedź na to pytanie spowoduje, że wszystkie wywołania opcji Otwórz zewnętrzną dokumentację Javadoc będą korzystać z tworzonej właśnie dokumentacji.
Zostanie uruchomiony nowy proces i dokumentacja będzie generowana w tle. Aby wyświetlić informacje o postępie i statusie generowania, należy otworzyć widok Konsola (Okna > Pokaż widok > Konsola).
Tworzenie dokumentacji Javadoc