Pytania otagowane jako javadoc

Javadoc to rozszerzalny system generowania dokumentacji, który czyta specjalnie sformatowane komentarze w kodzie źródłowym Java i generuje skompilowaną dokumentację. Zwykle jest używany do tworzenia dokumentacji API w postaci stron internetowych HTML.

3
Jak odwołać się do metody w javadoc?
Jak mogę użyć @linktagu, aby połączyć się z metodą? Chcę się zmienić: /** * Returns the Baz object owned by the Bar object owned by Foo owned by this. * A convenience method, equivalent to getFoo().getBar().getBaz() * @return baz */ public Baz fooBarBaz() do: /** * Returns the Baz object …
864 java  hyperlink  javadoc 
15
Przykład kodu wielu linii w komentarzu Javadoc
Mam mały przykład kodu, który chcę uwzględnić w komentarzu Javadoc dla metody. /** * -- ex: looping through List of Map objects -- * <code> * for (int i = 0; i < list.size(); i++) { * Map map = (Map)list.get(i); * System.out.println(map.get("wordID")); * System.out.println(map.get("word")); * } * </code> * …
531 java  html  javadoc 
4
Jak dodać odwołanie do parametru metody w javadoc?
Czy istnieje sposób dodawania odniesień do jednego lub więcej parametrów metody z treści dokumentacji metody? Coś jak: /** * When {@paramref a} is null, we rely on b for the discombobulation. * * @param a this is one of the parameters * @param b another param */ void foo(String a, …
313 java  arguments  javadoc 
17
Maven nie działa w Javie 8, gdy tagi Javadoc są niekompletne
Odkąd korzystam z Maven, byłem w stanie zbudować i zainstalować w moim lokalnym repozytorium projekty, które mają niekompletne tagi Javadoc (na przykład brakujący parametr). Ponieważ jednak przeprowadziłem migrację do Javy 8 (1.8.0-ea-b90), Maven jest absolutnie surowy w kwestii brakujących znaczników dokumentacji i pokazuje mi wiele błędów Javadoc związanych z problemami …
12
Jak dołączyć javadoc lub źródła do słoików w folderze libs?
Nowa wersja wtyczki ADT r17 do Eclipse dodaje funkcję automatycznego ustawiania zależności JAR. Wszelkie pliki .jar w folderze / libs są teraz dodawane do konfiguracji kompilacji. Niestety kontener ścieżki klas zależności systemu Android jest niemodyfikowalny. Jak mogę dołączyć javadoc i źródła do automatycznie wstawionego pliku .jar (z folderu / libs)?
254 android  eclipse  adt  javadoc 
3
Łącze Javadoc do metody w innej klasie
Obecnie odwołuję się do metod w innych klasach za pomocą następującej składni Javadoc: @see {@link com.my.package.Class#method()} I z tego, co rozumiem z dokumentacji, jest to właściwy sposób na zrobienie tego. Ale teraz do zabawnej części lub frustrujące. Kiedy generuję javadoc, przede wszystkim pojawia się następujący błąd: warning - Tag @see:illegal …
238 java  javadoc 
1
Javadoc: package.html lub package-info.java
Kiedy próbujesz utworzyć komentarze Javadoc na poziomie pakietu, jaka jest preferowana metoda? Co robisz? package-info.java Plusy Nowszy Cons Nadużycie klasy - Klasy dotyczą kodu, a nie tylko komentarzy pakiet.html Plusy Rozszerzenie HTML oznacza, że ​​nie jest to kod Podświetlanie składni w edytorach IDE / tekstowych Cons Żaden? Dla mnie zawsze …
230 java  javadoc 
17
Pobierz źródłowe pliki jar dołączone do Eclipse dla zależności zarządzanych przez Maven
Używam Maven (i Maven Eclipse Integration) do zarządzania zależnościami dla moich projektów Java w Eclipse. Funkcja automatycznego pobierania plików JAR z repozytoriów Maven to oszczędność czasu rzeczywistego. Niestety nie zawiera dokumentacji API i kodu źródłowego. Jak skonfigurować Mavena, aby automatycznie pobierał również załączniki źródłowe i javadoc oraz poprawnie je rejestrował …
176 eclipse  maven-2  javadoc 
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.