Eclipse, wie man ein Glas mit Javadocs / Source mit seiner Binärdatei verknüpft?

80

Ich möchte, dass die in einer JAR-Datei enthaltenen Javadoc-Kommentare in Eclipse angezeigt werden, wenn ich mit der Maus über eine Klasse fahre.

Nach dem Herunterladen von JODA-2.0 werden beispielsweise drei Gläser erhalten:

In Eclipse enthält [Rechtsklick auf Projekt -> Eigenschaften -> Java-Erstellungspfad -> Bibliotheken -> JARs HINZUFÜGEN ...] die Binärdatei für joda-time-2.0.jar im Projekt (kann auf diese Klassen verweisen).

Aber wie kann ich die in den anderen beiden JAR-Dateien enthaltenen Quellen / Javadoc-Kommentare verknüpfen, damit ich die Javadocs sehe, wenn ich mit der Maus über diese Klassen fahre?

Durch Hinzufügen der beiden anderen Jars (joda-time-2.0-javadoc.jar und joda-time-2.0-sources.jar) zum Erstellungspfad werden die Javadocs oder die Quelle nicht verknüpft.

java  eclipse  jar  javadoc 
— Erdsprung
quelle

Antworten:

67

Sie können versuchen, mit STRG + auf eine Klasse zu klicken, an die keine Quelle angehängt ist (tun Sie dies im Editor). Wenn Ihnen einige Informationen zur Klasse angezeigt werden, wird die Schaltfläche zum Anhängen des Quelldialogs angezeigt. Klicken Sie darauf und wählen Sie im daraufhin angezeigten Dialogfeld den Quell- / Javadoc-Speicherort für Ihre Klasse aus.

Sie können dies auch über die von Ihnen erwähnten Einstellungen für den Projekterstellungspfad tun: Wählen Sie die Registerkarte Bibliotheken aus, erweitern Sie die gewünschte Bibliothek (JAR), und Sie können Folgendes auswählen: Quellanhang, Javadoc-Anhang, Speicherort der nativen Bibliothek usw. Sie wählen einfach aus was auch immer Sie wollen und bearbeiten Sie die aktuellen Einstellungen.

Oder Sie können tun, was @JB Nizet sagte ...

— Draganstankovic
quelle
8
Was ist der Unterschied zwischen dem Anhängen einer Quelle und dem Anhängen von Javadoc ?
— Pacerier
Die @ Pacerier- Quelle enthält den Programmquellcode, wobei javadoc Dokumentation und Kommentare enthält , in denen die Funktionalität des Programms erläutert wird.
— Stevoisiak
1
Ich erhalte die Meldung "Die JAR dieser Klassendatei gehört zum Container 'Android Private Libraries', der keine Änderungen an
— Quellanhängen
70
  1. Klicken Sie mit der rechten Maustaste auf das Projekt -> Erstellungspfad -> Erstellungspfad konfigurieren
  2. Wechseln Sie im neuen Fenster zur Registerkarte "Bibliotheken".
  3. Wählen Sie die Bibliothek aus und erweitern Sie sie.
  4. Es gibt 4 untergeordnete Optionen. Wählen Sie "Javadoc-Speicherort" und klicken Sie rechts auf die Schaltfläche "Bearbeiten".
  5. Jetzt können Sie eine JAR-Datei hinzufügen, die die Dokumente enthält. Dies wäre nur eine Zip-Datei, deren Erweiterung in jar geändert wurde. Stellen Sie sicher, dass sich die Datei index.html im JAR im Stammverzeichnis befindet. Sie können auf die Schaltfläche "Validieren" klicken, um zu überprüfen, ob alles in Ordnung ist.
— Herr Smith
quelle
bis 3. Wählen Sie die Bibliothek direkt aus, nicht die in den privaten Android-Bibliotheken aufgeführte (es gibt keine Bearbeitungsfunktion). Zu 4: Verwenden Sie Javadoc in Archiven, nicht URL
— Gunnar Bernstein
Wenn Sie eine allgemeine Bibliothek verwenden, können Sie einen Link zur API online anhängen, anstatt einen fest codierten lokalen Pfad zur JAR-Datei.
— Sina Madani
11

Klicken Sie mit der rechten Maustaste auf das JAR (das mit den Klassendateien), wählen Sie "Eigenschaften", den "Javadoc-Speicherort" und wählen Sie die JAR-Datei mit dem Javadoc aus. Gehen Sie für das Quell-Jar ähnlich vor, indem Sie "Java-Quellanhang" verwenden.

— JB Nizet
quelle
4
Es könnte nur ich sein, aber das funktioniert nur, wenn Eclipse die Datei als JAR "erkennt". Dass es sich um ein kleines Glas-Symbol handelt. Wenn ich Gläser von Drittanbietern importiere, werden sie mit einem scheinbaren Dokumentsymbol angezeigt. Sie funktionieren gut in Bezug auf Code, aber wenn ich mit der rechten Maustaste auf Eigenschaften klicke, erhalte ich keinen "Javadoc-Speicherort".
— Miguel Moll
Wenn sich Ihre Gläser in WEB-INF / lib befinden, sollten Sie nicht mit der rechten
— Maustaste darauf
9

Sie können den Klassenpfad auch in der Datei ".classpath" in Ihrem Eclipse-Projekt bearbeiten. Dies kann hilfreich sein, wenn Sie viele Einträge gleichzeitig ändern oder den Pfad generieren möchten. z.B:

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

— Michael_S
quelle
+1 Antwort! Ich dachte an eine solche Methode, um sie für verschiedene Gläser gleichzeitig hinzuzufügen.
— Vikas Raturi
-1 Sie möchten die .classpath-Datei nicht direkt bearbeiten. Es soll nur von Eclipse verwendet und nicht manuell bearbeitet werden. @Mister Smith gibt hier tatsächlich die richtige Antwort. Obwohl Draganstankovic eine Methode erklärt, die zumindest die Arbeit erledigen wird ...
— aaiezza
@scribaniwannabe: Ich weiß, dass dies weder der beabsichtigte, unterstützte noch der einfachste Weg ist, aber für die von mir erwähnten Anwendungsfälle funktioniert es viel schneller und ohne Probleme. Sie müssen jedoch vorsichtig sein, um eine gültige XML-Syntax zu verwenden.
— Michael_S
0

Der einfachste Weg ist:

  1. Drücken Sie Strg + (Das Wort, für das Sie das Java-Dokument anzeigen möchten)
  2. Eine Seite mit einer Schaltfläche zum Anhängen der Quelle wird angezeigt. Klicken Sie hier
  3. Wählen Sie Externer Standort.
  4. Durchsuchen Der Speicherort im Java-Ordner als Ihr jdk .Than- src ZIP- Ordner .
  5. drücke OK.

Das Problem ist gelöst.

— Raj
quelle
Durch die Nutzung unserer Website bestätigen Sie, dass Sie unsere Cookie-Richtlinie und Datenschutzrichtlinie gelesen und verstanden haben.
Licensed under cc by-sa 3.0 with attribution required.