Eclipse, jak połączyć jar zawierający javadocs / source z jego plikiem binarnym?

80

Chciałbym, aby komentarze javadoc zawarte w pliku jar były wyświetlane w zaćmieniu, gdy najeżdżam kursorem na klasę.

Przykładowo po pobraniu JODA-2.0 uzyskujemy trzy słoiki:

W eclipse, [projekt kliknięcia prawym przyciskiem myszy -> Właściwości -> Ścieżka budowania Java -> Biblioteki -> DODAJ pliki JAR ...] zawiera plik binarny w projekcie (może odwoływać się do tych klas) dla joda-time-2.0.jar.

Ale jak mogę utworzyć link w komentarzach sources / javadoc zawartych w pozostałych dwóch plikach jar, aby po najechaniu kursorem na te klasy zobaczyłem javadocs?

Dodanie pozostałych dwóch plików JAR (joda-time-2.0-javadoc.jar i joda-time-2.0-sources.jar) do ścieżki budowania nie łączy javadoców ani źródła.

earthbounce
źródło

Odpowiedzi:

67

Możesz spróbować nacisnąć klawisz CTRL i kliknąć klasę, która nie ma dołączonego źródła (zrób to w edytorze). Gdy wyświetli informacje o zajęciach, zobaczysz przycisk prowadzący do dołączenia okna dialogowego źródła. Kliknij go iw wyświetlonym oknie dialogowym wybierz lokalizację źródła / javadoc dla swojej klasy.

Możesz to również zrobić z ustawień ścieżki budowania projektu, o których wspominasz: wybierz kartę bibliotek, rozwiń bibliotekę (jar), którą chcesz, a otrzymasz propozycję wyboru: załącznika źródłowego, załącznika javadoc, lokalizacji biblioteki natywnej itp. Po prostu wybierz cokolwiek chcesz i edytuj jego bieżące ustawienia.

Lub możesz zrobić tak, jak powiedział @JB Nizet ...

draganstankovic
źródło
8
Jaka jest różnica między dołączaniem źródła a dołączaniem javadoc ?
Pacerier
Źródło @Pacerier zawiera kod źródłowy programu, gdzie javadoc zawiera dokumentację i komentarze wyjaśniające funkcjonalność programu.
Stevoisiak
1
Otrzymuję komunikat „JAR tego pliku klasy należy do kontenera„ Prywatne biblioteki Androida ”, który nie pozwala na modyfikowanie załączników źródłowych w swoich wpisach
Radon8472
70
  1. Kliknij prawym przyciskiem myszy projekt -> Ścieżka kompilacji -> Konfiguruj ścieżkę kompilacji
  2. W nowym oknie przejdź do zakładki „Biblioteki”.
  3. Wybierz bibliotekę i rozwiń ją.
  4. Istnieją 4 opcje dla dzieci. Wybierz „Lokalizacja Javadoc” i kliknij przycisk „Edytuj” po prawej stronie.
  5. Teraz możesz dodać plik jar zawierający dokumenty. Byłby to po prostu plik zip z rozszerzeniem zmienionym na jar. Upewnij się, że w słoiku plik index.html znajduje się w katalogu głównym. Możesz nacisnąć przycisk „Zatwierdź”, aby sprawdzić, czy wszystko jest w porządku.
Panie Smith
źródło
do 3. Wybierz bibliotekę bezpośrednio, a nie tę wymienioną w prywatnych bibliotekach systemu Android (nie ma funkcji edycji). Do 4: Użyj Javadoc w archiwach, a nie URL
Gunnar Bernstein
Wystarczy dodać, że jeśli korzystasz ze wspólnej biblioteki, możesz dołączyć link do interfejsu API online zamiast zakodowanej na stałe lokalnej ścieżki do pliku JAR.
Sina Madani,
11

Kliknij prawym przyciskiem myszy jar (ten z plikami klas), wybierz „Właściwości”, „Lokalizację Javadoc” i wybierz plik jar z javadoc. Zrób podobnie dla jar ze źródłami, używając „załącznika źródłowego Java”.

JB Nizet
źródło
4
Mogę być tylko ja, ale działa to tylko wtedy, gdy Eclipse „rozpozna” plik jako jar. Że to jest obok niego mała ikona słoika. Kiedy importuję słoiki innych firm, pojawiają się one z czymś, co wygląda jak ikona dokumentu. Działają dobrze pod względem kodu, ale właściwości po kliknięciu prawym przyciskiem myszy nie otrzymuję „lokalizacji javadoc”.
Miguel Moll
Jeśli twoje słoiki znajdują się w WEB-INF / lib, nie powinieneś klikać ich prawym przyciskiem myszy (jak powiedziałeś, pojawiają się jako dokumenty), ale z odpowiednika w „Bibliotekach aplikacji internetowych”
xtian
9

Możesz także edytować klasę uwierzytelnienia w pliku „.classpath” w swoim projekcie eclipse. Może to być pomocne, jeśli chcesz zmodyfikować wiele wpisów jednocześnie lub jeśli chcesz wygenerować ścieżkę. na przykład:

<classpathentry kind="var" path="HOME/3rdparty/junit.jar" sourcepath="/SOURCE/junit_src.zip"/>

Michael_S
źródło
+1 odpowiedź! Myślałem o takiej metodzie dodawania na raz do różnych słoików.
Vikas Raturi
-1 Nie chcesz bezpośrednio edytować pliku .classpath. Jest przeznaczony do użytku tylko przez zaćmienie, a nie do edycji ręcznie. @Mister Smith faktycznie podaje tutaj prawdziwą poprawną odpowiedź. Chociaż draganstankovic wyjaśnia metodę, która przynajmniej wykona zadanie ...
aaiezza
@scribaniwannabe: Wiem, że nie jest to zamierzony, obsługiwany ani najłatwiejszy sposób, ale w przypadkach użycia, o których wspomniałem, działa znacznie szybciej i bez problemów. Musisz jednak uważać, aby używać prawidłowej składni XML.
Michael_S
0

Najłatwiej jest:

  1. Naciśnij control + (słowo, dla którego chcesz zobaczyć dokument Java)
  2. Pojawi się strona z przyciskiem dołączania źródła. Kliknij To
  3. Wybierz Lokalizacja zewnętrzna.
  4. Przeglądaj lokalizację do folderu Java, a nie jdk .Następnie wybierz src .zip.
  5. wciśnij OK.

Problem jest rozwiązany.

raj
źródło