Ich habe das Handbuch von javadoc überprüft und einige davon gelesen posten hier auf stackoverflow (zum Beispiel Bilder in javadocs aufnehmen ), konnten aber kein zufriedenstellendes Ergebnis erzielen
Ich möchte ein Bild in meinem Javadoc bereitstellen, das mit dem erstellten HTML-Code gepackt werden soll. Hier sind die Schritte, die ich mache:
doc-files unter src/main/java (dies ist ein Großprojekt in STS) classhierarchy.png in das neu erstellte Verzeichnis <img src="doc-files/classhierarchy.png"> zum Javadoc meiner Klasse hinzu de.company.some.more.levels.MyClass
Ich kann sehen, dass die PNG-Datei nach C: \ temp \ NameOfProject \ doc \ doc-dateien kopiert wird, aber nicht angezeigt werden kann, weil der img-link relativ zum Paket ist: c: /temp/NameOfProject/doc/de/company/some/more/levels/doc-files/classhierarchy.png
Ich weiß, dass ich das beheben könnte, indem ich dem Pfad viele /../../ voranstelle, aber ich würde das anpassen müssen, wenn sich die Pakettiefe ändert:
%Vor%Die zweite Sache, die ich nicht mag, ist die Tatsache, dass sich Verzeichnis-doc-Dateien im selben Pfad befinden wie mein Quellcode.
Wie kann ich die Bilder elegant verknüpfen und bereitstellen?
Oft sprechen Bilder mehr als Worte. Aber eine Klassenhierarchie kann sich ohne Auswirkung auf das Bild selbst ändern. Vielleicht verwenden Sie andere Dokumentationstechniken wie die Site von maven .
In Ihrem Fall ist es ein BW-Bild oder? Vielleicht solltest du besser ascii-art .
Kleine Bilder können auch inline wie folgt verwendet werden:
%Vor%Ich kann zumindest eine Lösung für die reichlich vorhandenen ".." s bieten. Anstatt zu schreiben:
%Vor%können wir verwenden:
%Vor% Dies wird Javadoc anweisen, das ".." selbst einzufügen, damit ich mich nicht zählen muss ;-) und ich muss die ".." s nicht anpassen, wenn sich die Paketstruktur ändert.
Der Parameter @docroot kann im Code und in der Befehlszeile verwendet werden, für Details siehe die Dokumente
In meinen Tests funktionierte das mit dem generierten HTML und Live in Eclipse.