Generieren von Javadoc als Word -Dokument

StackOverflow https://stackoverflow.com/questions/1606255

  •  05-07-2019
  •  | 
  •  

Frage

Wie können wir Javadoc als Wortdokument anstelle der herkömmlichen HTML -Seiten generieren?

War es hilfreich?

Lösung

Schauen Sie sich Doklets an, http://doclet.com die viele Beispiele für kundenspezifische Javadoc -Rendering (dh in PDFs usw.) haben und auch Apache Poi (untersuchenhttp://poi.apache.org/) für die Erzeugung von MS -Office -Dateien

Andere Tipps

Wenn Sie mit PDF anstelle von Wort leben könnten, sollten Sie geben Pdfdoclet eine Chance. Ich habe es auf Doclet.com entdeckt (dank Mark für den Link). Es funktioniert ganz gut, nützt sich und ermöglicht eine gewisse Konfiguration. Für meinen Zweck ist PDF besser geeignet als ein Wort, da ein PDF -Dokument besser zum Lesen geeignet ist als ein Wort in Bezug auf die erforderliche Betrachteranwendung.

Hier ist meine kleine Windows -Batch -Datei:

echo OFF

set JAVA_HOME=C:/program files/Java/jdk1.6.0_23
set PATH=%JAVA_HOME%/bin;%PATH%
set VERSION=1.0.2
set DOCLET=com.tarsec.javadoc.pdfdoclet.PDFDoclet
set JARS=jar/pdfdoclet-%VERSION%-all.jar
set PACKAGE="cvu.html"

javadoc -doclet %DOCLET% -docletpath %JARS% -pdf html.pdf -config example/html/config_html.properties -private -sourcepath example/html -subpackges %PACKAGE%

http://doclet.com/ Links ein RTF Doclet ("RTF Doclet generiert eine RTF -Formatdokumentation.") Das resultierende RTF öffnet sich in Word- und Open Office Writer.

Sie können Maven verwenden, um die auszuführen pdfdoclet. Obwohl ich kein "offizielles" Maven-Repository gefunden habe, scheint mir das Folgende klarer zu sein, das sich gegen das Fummeln mit Shell-Skripten oder die Verwendung von Anteilen in Maven wie vorgeschlagene auf ihren Webseite:

        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.9.1</version>

            <configuration>
                <doclet>com.tarsec.javadoc.pdfdoclet.PDFDoclet</doclet>
                <docletPath>path/to/pdfdoclet-1.0.2-all.jar</docletPath>
                <useStandardDocletOptions>false</useStandardDocletOptions>
            </configuration>
        </plugin>

Beachten Sie die Deaktivierung der Standardoptionen, ansonsten klagen Javadoc über unbekannte Optionen (offenbar nicht vom PDFDoclet unterstützt).

Von dort aus können Sie mit dem immer konzitierenden Anpassen beginnen Maven -Dokumentation

Sie können kein Wortdokument direkt generieren. Sie können jedoch versuchen, Word -Dokument (n) aus generierten HTML -Dateien zu generieren: Google suchen

Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top