Übersetzungen aus Code-Dokumentation
Jedes Modul kann Übersetzungen und Dokumentation für Konfigurationsparameter in META-INF/messages_en.properties
(entsprechend für andere Sprachen mit der Endung _de.properties
, _es.properties
, ...) enthalten. Diese Dateien werden mit in das JAR
des Moduls gepackt und stehen zur Laufzeit über die allgemeine API für Resourcen zur Verfügung (vgl. Internationalisierung).
Automatische Generierung über JavaDoc
Die passenden Keys mit ihrer englischen Übersetzung (die Datei messages_en.properties
) werden dabei automatisch durch den JavaDoc-Prozess erzeugt. Hierbei wird aus dem Namen eines Konfigurationsproperties eine englische Übersetzung für das Property erzeugt und aus dem JavaDoc-Kommentar für das Property ein entsprechender Tool-Tip für das Property, der weitere Dokumentation enthält.
Automatische Übersetzung mit DeepL
Liegt ein API-Key für den DeepL-Übersetzer vor, können ausgehend aus der Code-Dokumentation auch automatische Übersetzungen in anderen Sprachen erzeugt werden. Hierfür muss in den Maven-Settings eine Konfiguration für die Server-ID deepl
hinterlegt werden:
In ~/.m2/settings.xml
:
<server>
<id>deepl</id>
<passphrase>[your-deepl-api-key]</passphrase>
</server>
In diesem Fall erstellt der der JavaDoc-Prozess Übersetzungen in allen in dem Build-Property tl.javadoc.targetLanguages
angegebenen Sprachen (sofern diese von DeepL unterstützt werden). Es wird empfohlen, diese Build-Ergebnisse mit in die Source-Code-Verwaltung zu übernehmen, da die automatischen Übersetzungen manuell überprüft und gegebenenfalls angepasst werden müssen. Auch verursacht die automatische Übersetzung Kosten, so dass diese nicht in jedem Build-Lauf der Anwendung durchgeführt werden sollte.