Preferencje dokumentacji Javadoc kompilatora Java

Strona preferencji Otwiera stronę preferencji Dokumentacja Javadoc Java > Kompilator > Dokumentacja Javadoc pozwala określić preferencje dotyczące ustawień dokumentacji Javadoc.

Opcja

Opis

Wartość domyślna

Przetwarzaj komentarze dokumentacji Javadoc (również dla wyszukiwania i refaktoryzacji)

Po zaznaczeniu tej opcji program budujący wykrywa problemy w komentarzach dokumentacji Javadoc. Tę opcję należy również włączyć, aby aktywować funkcję wyszukiwania i refaktoryzacji dla komentarzy Javadoc.

Włączone

Zniekształcone komentarze dokumentacji Javadoc

Po włączeniu tej opcji kompilator zgłosi błąd lub ostrzeżenie w przypadku napotkania zniekształconego komentarza dokumentacji Javadoc.

Ignorowanie

Bierz pod uwagę tylko składowe o widoczności

Po włączeniu tej opcji kompilator sprawdza wyłącznie składowe o określonej lub szerszej widoczności.

Publiczne

Sprawdź poprawność argumentów znaczników (@param, @throws, @exception, @see, @link)

Po włączeniu tej opcji kompilator zgłosi błąd lub ostrzeżenie w przypadku napotkania błędu w argumencie znacznika komentarza Javadoc dla znaczników @param, @throws, @exception, @see i @link.

Wyłączone

Zgłaszaj niewidoczne odwołania

Po włączeniu tej opcji kompilator zgłosi błąd lub ostrzeżenie w przypadku napotkania odwołania do niewidocznego elementu.

Wyłączone

Zgłaszaj nieaktualne odwołania

Po włączeniu tej opcji kompilator zgłosi błąd lub ostrzeżenie w przypadku napotkania odwołania do nieaktualnego elementu.

Wyłączone

Brak opisów znaczników

Dostępne są następujące wartości: Sprawdź poprawność wszystkich standardowych znaczników, Sprawdź poprawność znaczników @return lub Ignoruj. Po włączeniu tej opcji kompilator zgłosi błąd lub ostrzeżenie w przypadku napotkania brakującego opisu znacznika.

Sprawdź poprawność znaczników @return

Brak znaczników dokumentacji Javadoc

Po włączeniu tej opcji kompilator zgłosi błąd lub ostrzeżenie w przypadku napotkania brakującego znacznika dokumentacji Javadoc (np. brakującego znacznika @param w odniesieniu do parametru).

Ignorowanie

Bierz pod uwagę tylko składowe o widoczności

Po włączeniu tej opcji kompilator sprawdza wyłącznie składowe o określonej lub szerszej widoczności.

Publiczne

Ignoruj w metodach przesłaniających i implementujących.

Po włączeniu tej opcji metody przesłaniające lub implementujące inną metodę nie są sprawdzane pod kątem brakujących znaczników Javadoc.

Włączone

Ignoruj parametry typu metody

Po włączeniu tej opcji brakujące znaczniki Javadoc nie są zgłaszane dla parametrów typu metody.

Włączone

Brak komentarzy dokumentacji Javadoc

Po włączeniu tej opcji kompilator zgłosi błąd lub ostrzeżenie w przypadku napotkania brakującego komentarza dokumentacji Javadoc dotyczącego składowej języka Java.

Ignorowanie

Bierz pod uwagę tylko składowe o widoczności

Po włączeniu tej opcji kompilator sprawdza wyłącznie składowe o określonej lub szerszej widoczności.

Publiczne

Ignoruj w metodach przesłaniających i implementujących.

Po włączeniu tej opcji metody przesłaniające lub implementujące inną metodę nie są sprawdzane pod kątem brakujących komentarzy Javadoc.

Włączone