webentwicklung-frage-antwort-db.com.de

Wie hänge ich Javadoc oder Quellen an die JARs im Ordner libs an?

Neue Version des ADT r17-Plugins für Eclipse hinzugefügt, um JAR-Abhängigkeiten automatisch einzurichten. JAR-Dateien im Ordner/libs werden jetzt zur Build-Konfiguration hinzugefügt. Leider ist der Klassenpfad-Container für Android Abhängigkeiten nicht änderbar.

Non modifiable Android dependencies classpath

Wie kann ich Javadoc und Quellen an die automatisch eingefügte .jar-Datei (aus dem Ordner/libs) anhängen?

253

Am besten beantworten Sie Ihre Frage, indem Sie die Antworten von Xavier , plastiv , VinceFR und Christopher .

Schritt für Schritt Anleitung

Um die -Quellen und Javadoc mit einer .jar-Bibliothek zu verknüpfen, die automatisch von Eclipse verknüpft wird, müssen Sie folgende Schritte ausführen:

  1. Platzieren Sie die JAR-Datei der Bibliothek im Ordner libs und die zugehörigen JAR- und DOC-Quelldateien in separaten Unterordnern wie libs/src und = libs/docs. Sie können einen anderen Namen als src und docs verwenden, aber es ist wichtig, dass die .jar-Dateien nicht direkt in den libs Ordner.
  2. Erstellen Sie eine .properties - Datei im Ordner libs mit dem genauen Namen der eigentlichen Bibliothek .jar (siehe Beispiel). Stellen Sie sicher, dass Sie den Teil . Jar behalten.
  3. Geben Sie die relativen Pfade zu den Quellen und der Javadoc-JAR-Datei in der Datei .properties An.
  4. Schließen Sie und öffnen Sie das Eclipse-Projekt erneut! Aktualisieren Sie das Projekt optional durch Drücken von F5.
  5. Wählen Sie im Quellcode ein Objekt der verknüpften Bibliothek aus.
  6. Öffnen Sie die Javadoc-Ansicht in Eclipse, um die Dokumentation zu überprüfen (siehe Screenshot).
  7. Öffnen Sie die Quelltextdeklaration (Standardverknüpfung: F3) des ausgewählten Objekts.


Beispiel

In diesem Beispiel wird die Gson-Bibliothek verwendet.

Verzeichnisstruktur des libs-Ordners:

libs
├── docs
│   └── gson-2.2.2-javadoc.jar
├── gson-2.2.2.jar
├── gson-2.2.2.jar.properties
└── src
    └── gson-2.2.2-sources.jar

Inhalt von gson-2.2.2.jar.properties

src=src/gson-2.2.2-sources.jar
doc=docs/gson-2.2.2-javadoc.jar


Zusätzliche Information

Sie können die javadoc- und source-jar-Datei natürlich in andere Ordner verschieben und relative Pfade angeben. Das liegt an dir. Das direkte Ablegen der Quell- und Javadoc-Gläser in den Ordner lib ist möglich, wird jedoch nicht empfohlen , da dies die Dokumentation und den Quellcode verursacht Code, der in Ihrer Anwendung enthalten sein soll .


Screenshot des Eclipse JavaDoc-Fensters:

JavaDoc view in Eclipse

Screenshot eines Eclipse-Projekts mit Gson mit Android 4.2.2 .:

Eclipse test project screenshot


Verweisen auf entpackte Javadocs

Falls Sie auf Javadocs verweisen möchten, die nicht als gepacktes .jar Bereitgestellt werden, sondern einfach als Dateien und Ordner , wie von Android-Entwickler in den Kommentaren machen folgendes:

  1. Legen Sie die Bibliothek .jar In den Ordner libs/
  2. Erstellen Sie eine yourlibraryname.jar.properties - Datei ( Vergessen Sie nicht den .jar) mit folgendem Inhalt:

     doc=docs
    
  3. Fügen Sie die Javadocs-Ordner zum Ordner libs/ Hinzu.

Sie sollten sich folgende Ordnerstruktur einfallen lassen:

├── docs
│   ├── allclasses-frame.html
│   ├── allclasses-noframe.html
│   ├── com
│   │   └── google
│   │       └── ads
│   │           ├── Ad.html
│   │           │   ....
│   │           └── package-tree.html
│   │   ...
│   └── stylesheet.css
├── GoogleAdMobAdsSdk-6.4.1.jar
└── GoogleAdMobAdsSdk-6.4.1.jar.properties

Vergessen Sie nicht, das Eclipse-Projekt wie oben beschrieben zu schließen und erneut zu öffnen ! Hier ist ein Screenshot eines funktionierenden Beispielprojekts, das auf die GoogleAdMobAds Android library verweist.

GoogleAdMobAds Android library Eclipse project

401
JJD

Unter Windows müssen Sie den Backslash für Verweise auf doc- und src-Pfade in der Eigenschaftendatei umgehen. Beispiel: Für Android-support-v4.jar sieht der Inhalt der Eigenschaftendatei folgendermaßen aus:

doc=C:\\Program Files (x86)\\Android\\Android-sdk\\extras\\Android\\support\\v4\\docs
src=C:\\Program Files (x86)\\Android\\Android-sdk\\extras\\Android\\support\\v4\\src
25
farid_z

Eine Antwort kommt von http://code.google.com/p/Android/issues/detail?id=27490#c21

In Ihrem libs-Ordner müssen Sie Folgendes haben:

doc(folder)
    foo_doc(folder)
        index.html
        ...
        ...
foo.jar
foo.jar.properties

Und in deinem foo.jar.properties, lege einfach doc=./doc/foo_doc

Möglicherweise müssen Sie Ihr Projekt aktualisieren, bereinigen, schließen und erneut öffnen.

Für mich geht das!

17
VinceFR

Ich habe all das ausprobiert und keiner von ihnen hat für mich funktioniert. Ich habe eine Methode gefunden, die immer funktioniert. Grundsätzlich ist der Täter die Art und Weise, wie der ADT den Ordner "libs" behandelt, sodass ich den Ordner "libs" beende. Stattdessen habe ich einen "Bibliotheks" -Ordner erstellt und verwendet.

Sie können Folgendes tun, und es wird immer funktionieren - auch wenn das ADT in Zukunft ändern sollte, wie es mit dem Ordner "libs" umgeht:

  1. Erstellen Sie einen Ordner "Bibliotheken".
  2. Erstellen Sie für jede Bibliothek einen Unterordner darunter.
  3. Legen Sie alle Dateien für jede Bibliothek in den entsprechenden Ordner (Java-JAR-Datei, Quell-JAR-Datei, Javadoc-JAR-Datei usw.).
  4. Fügen Sie die Java jar-Datei für jedes Projekt auf der Registerkarte "Bibliotheken" für den Java Build Path hinzu, indem Sie auf klicken Add Jars... Klicken Sie auf die Schaltfläche, um das Glas aus dem Bibliotheksunterordner im Ordner "Bibliotheken" hinzuzufügen.
  5. Hängen Sie die Quelle/Javadocs an jedes Projekt an, indem Sie das Projekt auf der Registerkarte "Bibliotheken" öffnen, das gewünschte Element auswählen und auf klicken Edit... Klicken Sie auf die Schaltfläche, um die Quelle/Javadocs aus dem Bibliotheksunterordner im Ordner "Bibliotheken" hinzuzufügen.
  6. Aktivieren Sie das Kontrollkästchen für jedes Projekt auf der Registerkarte "Bestellen und Exportieren" für den Erstellungspfad Java Build Path.
  7. Nachdem Sie überprüft haben, dass alle Bibliotheken verschoben wurden, löschen Sie den Ordner "libs".

Wenn Sie wie oben beschrieben vorgehen, weist Ihr Projekt Ordner auf, die wie folgt aussehen:

enter image description here

Ihr Java Build Path sieht ungefähr so ​​aus:

enter image description here

In Order and Export sind die Bibliotheken angekreuzt:

enter image description here

10

Verschieben Sie die Bibliothek, die Javadoc haben soll, zunächst in lib. Sie fügen diese Bibliothek zum Build Path und fügen Sie den Javadoc hinzu.

Überprüfen Sie dies Kommentar in den Android Issues.

5
Carlos Sobrinho

Am ADT 22 konnte ich nicht auf Javadoc sowohl für commons-io-2.4.jar als auch für Android-support-v4.jar zugreifen

So habe ich es behoben:

  1. Voraussetzung: Beide Bibliotheken sind unter "Referenzierte Bibliotheken" aufgeführt.

  2. Klicken Sie mit der rechten Maustaste auf commons-io-2.4.jar und wählen Sie Eigenschaften. Dieses Fenster erscheint:

enter image description here

da commons-io-2.4.jar mit commons-io-2.4-javadoc.jar gebündelt ist, habe ich den Javadoc-Pfad im Archiv Externer Dateipfad angegeben.

Für die Support-Bibliothek habe ich dasselbe getan: Rechtsklick auf Android-support-v4.jar und Eigenschaften auswählen. Dieser Bildschirm erscheint:

enter image description here

Diesmal habe ich den Pfad zum Quellverzeichnis angegeben.

4
Javide

Der Bibliotheksverweis auf commons-io-2.0.1.jar war fehlerhaft, als ich ein Upgrade auf SDK Tools und ADT Revision 17 durchführte.

Um das Problem zu lösen, habe ich Project -> Properties -> Java Build Path) verwendet und die Registerkarte Libraries ausgewählt. Ich habe alle Verweise auf commons-io-2.0.1.jar gelöscht und dann Add Jar verwendet Um commons-io-2.0.1.jar erneut zum Projekt hinzuzufügen, klicke ich auf den Pfeil '>' neben dem Bibliotheksnamen, um den Bibliotheksverweis zu erweitern, und verwende die Bearbeitungsschaltflächen, um den Quellanhang und den Javadoc-Speicherort festzulegen .

Leider kann ich kein Bild posten, da ich nicht genug Repräsentanten habe (bitte ...).

3
Mark Gittoes

Scheint ein sich bewegendes Ziel zu sein, aber nachdem es an vielen Stellen Kleinigkeiten gesammelt hat (einschließlich der Antworten auf diese Frage, die geholfen hat, aber nicht alle notwendigen Details beschrieben hat, oder vielleicht das System sich in der Zwischenzeit geringfügig geändert hat), scheint dies so zu sein die Lösung zumindest ab sofort (28. August 2013).

  • Öffne irgendwo in deinem Projekt einen Ordner für deine Javadocs nicht.
  • Legen Sie Ihre Javadocs dort ab entpackt, jeweils in einen eigenen Ordner.
  • Fügen Sie in Ihrem lib -Ordner ein xxx.jar.properties-Datei für jede Bibliothek, mit der Sie ein Javadoc verknüpfen möchten.
  • Verweisen Sie in dieser Eigenschaftendatei auf den Ordner , in den Sie das entsprechende Javadoc entpackt haben (unter Windows müssen Sie die umgekehrten Schrägstriche umgehen):

doc=d:\\Android\\javadoc\\libGoogleAnalyticsServices

  • Schließen Sie Ihr Projekt in Eclipse und öffnen Sie es erneut (Aktualisierung reicht nicht aus). Sie sollten jetzt die QuickInfos sehen, wenn Sie den Mauszeiger über die entsprechenden Klassen bewegen.

Die Nichtbeachtung eines dieser Schritte (kein Entpacken des Javadocs, Verweisen auf eine Datei anstelle eines Ordners usw.) scheint ihn zu beschädigen.

1
Gábor

Ich weiß, dass diese Frage ziemlich alt ist, aber als ich gestern vor dem gleichen Problem stand und die oben angegebene Lösung für mich viel zu ärgerlich war, stellte ich fest, dass man der .classpath-Datei des Projekts problemlos eine Quellpfaddefinition hinzufügen kann. Eclipse passt es dann an und Sie können die Quelle durchsuchen.

klassenpfadeintrag vor:

<classpathentry kind="lib" path="[PATH_TO_MY_JAR]"/>

Nachdem Sie den Pfad zur Quelle hinzugefügt haben

<classpathentry kind="lib" path="[PATH_TO_MY_JAR]" sourcepath="[PATH_TO_MY_SOURCE_JAR]"/>

Hoffe das hilft

1
zersaegen

Meine Lösung:

Laden Sie ein Eclipse-Plugin mit dem Namen "Java Source Attacher Feature" herunter.

Wählen Sie später ein Glas aus und hängen Sie den Quellcode mit diesem Plugin an. Klicken Sie in die JAR-Datei, um sie auszuwählen, und wählen Sie dann "attach Java source".

Wenn Sie den Quellcode haben, haben Sie automatisch das Javadoc.

Jetzt können Sie mit F2 über den Klassen den zugehörigen Javadoc anzeigen.

Genießen

0
Antonio Martin

Wenn Sie während des Codierens die Javadoc-Hilfe in der QuickInfo anzeigen möchten, gehen Sie für ein bestimmtes Jar folgendermaßen vor: Klicken Sie mit der rechten Maustaste auf Ihr Projekt> Eigenschaften> Java Build Path> Libraries Tab. Klicken Sie auf den Pfeil neben Ihrem Glas zu erweitern.

Quellanhang sollte auf den Speicherort des aktuellen Glases verweisen (wahrscheinlich direkt in Ihrem Java Ordner).

Javadoc-Speicherort: Hier haben Sie zwei Möglichkeiten: URL und Archiv. Wenn Ihre Javadocs für diese JAR-Datei in Form eines Ordners vorliegen, der eine index.html -Datei auf der ersten Ebene enthält, wählen Sie "Javadoc-URL" und zeigen Sie auf dieser Ordner. Wenn sich Ihre Javadocs in einem Glas befinden, wählen Sie "Javadoc im Archiv" und zeigen Sie auf das Glas. Vergessen Sie nicht, Ihren Arbeitsbereich neu zu starten/zu schließen und Ihr Projekt erneut zu öffnen, um den Tooltip mit den Javadoc-Informationen zu aktualisieren.

Ich hoffe, dies gibt eine einfache Antwort auf die meiner Meinung nach sehr einfache Aufgabe.

0
Casey Murray

aktualisieren Sie einfach das ADT-Plugin. Das hat bei mir funktioniert !!

  1. Starten Sie Eclipse und wählen Sie dann Hilfe> Neue Software installieren.
  2. Klicken Sie oben rechts auf Hinzufügen.
  3. Geben Sie im angezeigten Dialogfeld "Repository hinzufügen" "ADT Plugin" als Namen und die folgende URL als Speicherort ein: https://dl-ssl.google.com/Android/Eclipse/ Hinweis: Die Android Developer Tools-Update-Site erfordert eine sichere Verbindung. Stellen Sie sicher, dass die eingegebene Update-Site-URL mit HTTPS beginnt.
  4. OK klicken. Aktivieren Sie im Dialogfeld "Verfügbare Software" das Kontrollkästchen neben "Entwicklertools" und klicken Sie auf "Weiter".
  5. Im nächsten Fenster sehen Sie eine Liste der herunterzuladenden Tools. Weiter klicken.
  6. Lesen und akzeptieren Sie die Lizenzvereinbarungen und klicken Sie dann auf Fertig stellen.
  7. Wenn Sie eine Sicherheitswarnung erhalten, die besagt, dass die Authentizität oder Gültigkeit der Software nicht festgestellt werden kann, klicken Sie auf OK.
  8. Starten Sie Eclipse nach Abschluss der Installation neu

Ich hoffe, das hilft!

0
akshay