Einfügen von Bildern in javadocs

Arbeite ich mit einer Menge von Beispiel-Testfälle, die visual. Gibt es eine bequeme Möglichkeit, um Sie in meinem Java-Quellcode, und verknüpfen Sie Sie in den Javadocs, also meine IDE automatisch zeigen Sie Ihnen während der Codierung (durch aufrufen von javadoc-renderer-Funktion in meiner IDE?)

Ich versucht, indem Sie ein Bild neben dem Java-Quellcode und verwenden <img>, aber es ist nicht die (ich habe ein png).

(Hinweis - es ist in meinem test-Quellen in diesem Fall)

  • Warum nicht zeigen Sie uns, was Sie zu tun versuchen, mit etwas code? Verwenden Sie die Bearbeiten - link, um es hinzuzufügen. Viel Glück! 🙂
  • Ist dieser was Sie zu erreichen versuchen?
InformationsquelleAutor ianpojman | 2012-05-28
  1. 20

    Da Sie nicht das zeigen alle Quellen, ich kann nur tun, eine Glas-ball denke ...

    Für alle Dateien, die benötigt werden, für Zwecke der Dokumentation, sollte man steckte Sie in ein Unterverzeichnis mit dem Namen doc-files Ihrer Paket-Verzeichnisse. Diese werden dann einfach kopiert, die von Javadoc, um die Ausgabe-Verzeichnis. Dann verwenden Sie einen relativen Pfad in der <img> element.

    Ich bin mir nicht sicher, ob der IDE-Javadoc-renderer das gleiche tun, aber es ist einen Versuch Wert.

    • danke - aber das erfordert, mich für das javadoc-Werkzeug, das ich hoffte zu vermeiden (und wahrscheinlich macht diese situation unmöglich ist...)
    • Hochladen das Bild auf eine Website wie imgur arbeitet ein Genuss: <img src="https://i.imgur.com/GPzGu1N.png" /> In Aktion in IntelliJ
    • das scheint wie ein schlechter plan. Die Dokumentation soll nicht verschwinden, wenn einige zufällige website verschiebt oder schließt.
    InformationsquelleAutor Paŭlo Ebermann
  2. 31

    Etwas weit hergeholt, aber Sie können die inline-Bilder in der Dokumentation durch Umwandlung in Base64. Es würde dann so Aussehen:

    <img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIA..." />

    Gibt es online-tools zur Verfügung, um die Konvertierung zu tun:

    • Sie können verwenden Sie ein normales Bild, wie beschrieben von Paulo, aber das bedeutet, dass eine separate Datei zu verwalten.
    • Es ist meine Letzte Rettung hier seit Zeichnung, ascii-art, die in den Javadocs ist zu schmerzhaft.....
    • inteliJ tut nicht sehen, das Bild
    • Auch ich verwendet base64-Codierung bei der Anzeige von Bild. Wenn die Anwendung ausgeführt wird, von IntelliJ wird das Bild angezeigt, manchmal als leer. Aber das gleiche funktioniert, wenn die Anwendung ausgeführt wird, die in isolation nach der Bereitstellung. Alles falsch, dass ich das Tue?
    InformationsquelleAutor Emmanuel Bourg
  3. 9

    Mit Eclipse Luna die folgenden arbeiten für mich.

    • com
      • Unternehmen
        • somepackage
          • doc-Dateien
            • Bild.png
          • Test.java

    Nun in Test.java's javadoc:

    /**
 * <img src="./doc-files/image.png" />
 */

    Eclipse und zeigt das Bild sowohl in der popup-Hilfe, wenn Sie mit der Maus, und im Javadoc-Ansicht an.

    Können Sie auch hinzufügen style="width: 100%;" zu den img tag, also das Bild passt sich an die view/popup Größe.

    • Android Studio 3.0 (.k.ein IntelliJ) zeigt das Bild in der 'Quick-Dokumentation" popup.
    InformationsquelleAutor Vsevolod Golovanov
  4. 3

    Erweitern ein wenig auf Paŭlo Antwort vorausgesetzt wird ein maven-build, hier ist was für mich gearbeitet mit JDK-8 (strengere HTML-Validierung), mit der Maßgabe, dass Sie bereit sind, führen Sie das javadoc-tool.

    Leider mit Netbeans kann ich nicht sehen, das Bild in der IDE javadoc-popup, habe ich gerade eröffnet das netbeans-bug.

    Nehme an, dies ist Teil der javadoc für com.foo.File.java (beachten Sie, keine img-end-tag, das ist der richtige Weg, pro w3schools):

    <img src="doc-files/foo.png" alt="Foo">

    Im maven-Verzeichnis-Struktur finden Sie das Bild hier: src/main/javadoc/com/foo/doc-files/foo.png

    Und die Letzte, in der pom.xml (beachten Sie docfilessubdirs auf true gesetzt ist):

    <build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.10.3</version>
            <configuration>
                <docfilessubdirs>true</docfilessubdirs>
            </configuration>
        </plugin>
        ...
    InformationsquelleAutor Jason
  5. 1

    Stolperte ich über diese Frage, wie ich denn wohl wollte, zeigen meine icons. Nach der Lektüre der Antworten, ich war noch nicht zufrieden und versuchte es für mich selbst. Das ist, was ich jetzt habe:

         /**
     * <img src="../../../../../../resources/com/my/project/client/images/myImage.png"><br>
     * Icon for myImage.
     *
     * @return the icon
     */

    wie diese brauche ich nicht zu verwalten, weitere Bilder als vorher-gehen Sie einfach zu dem Ordner, in den die eigentlichen Bilder liegen im.

    InformationsquelleAutor BAERUS
  6. 1

    Diesem Weg versuchen

    /**
 * @author KamyninSA
 * @version 1
 * <p><b>Description</b></p>
 * <p><img src="{@docRoot}/../src/test/resources/doc-files/ads.png" alt="alternative directory"></p>
 * */
    InformationsquelleAutor Сергей Камынин
  7. 0

    Zu erweitern ein wenig auf Wsewolod Golovanov und Paulo Ebermann Antwort oben, hier ist ein konkretes Beispiel und weitere Ausarbeitung.

    Den Javadocs-Dokumentation besagt:

    Enthalten unverarbeitete Dateien, steckte Sie in ein Verzeichnis namens doc-Dateien werden in einem Unterverzeichnis des jeder Paket-Verzeichnis, das enthält die Quell-Dateien.

    Wenn Sie die Bilddateien in diesem Ordner werden Sie verfügbar sein, um die Javadocs von HTML-Dateien über den relativen Pfad aus dem generierten HTML-Code.

    So, wenn Ihr Projekt mit dem Namen MyProject und die Klasse, die Sie hinzufügen Javadoc-Kommentar zu org.foo.app.MyApp, die source-Ordner für die MyProject/src/org/foo/app/MyApp.java, und Sie möchten, fügen Sie MyImage.jpg im Javadoc, dann:

    Erstellen Sie den Ordner MyProject/src/org/foo/app/doc-Dateien, und legen Sie die image-Datei.

    In diesem Punkt Ihre Javadocs text verweisen können es so: 

    <img src="doc-files/MyImage.jpg" width="500" alt="description of MyImage">

    Und der Javadocs-generierten HTML-widerspiegeln werden, entsprechend geschlüsselt.

    Beachten Sie die "width" - Attribut, das eine Skalierung des Bildes. Die Höhe wird proportional skaliert.

    Wenn Sie führen Sie Javadocs, die doc-Dateien - Ordner alle kopiert werden, um die Javadocs Ausgabe-Ordner und die Ressourcen in Ihnen werden für die Verwendung von HTML.

    InformationsquelleAutor Roger Neyman
Schreibe einen Kommentar