Javadoc вставка UML-диаграмм

есть ли способ встроить изображения в мой JavaDoc? В основном я хочу включить некоторые диаграммы UML, объясняющие иерархию моих классов в некоторых документах.

спасибо!

23
class-diagram java javadoc

7 ответов

проверить в этом разделе документации Javadoc, в которой объясняется, как вставлять изображения в ваш Javadoc.

и вот это статьи описание того, как перепроектировать UML-диаграммы и встроить их в Javadoc с помощью UMLGraph.

23

да.

документация объясняет, как вставлять произвольные изображения в документацию javadoc.

Если вы хотите создать диаграммы классов UML из вашего источника Java, посмотрите на Доклет UMLGraph.

8

ApiViz тоже хороший Доклет.

3

Простой Ответ:

/**
 * This class does some stuff (see diagram).
 * <img src="relative/path/to/image.png" />
 * 
 */
 public class SomeClass{
 }
3

в этой статье показывает, как использовать UMLGraph с плагином Maven Javadoc.

короче:

  1. Установить GraphViz.

    Ubuntu:apt-get install graphviz4.
    Windows:скачать.

  2. обновить pom.XML.

        <plugin>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.7</version>
        <configuration>
            <aggregate>true</aggregate>
            <show>private</show>
            <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet>
            <docletArtifact>
                <groupId>org.umlgraph</groupId>
                <artifactId>doclet</artifactId>
                <version>5.1</version>
            </docletArtifact>
            <additionalparam>
                -inferrel -attributes -types -visibility -inferdep -quiet -hide java.* -collpackages java.util.* -qualify -postfixpackage
                -nodefontsize 9
                -nodefontpackagesize 7
            </additionalparam>
        </configuration>
    </plugin>

  3. выполнить mvn javadoc:javadoc.

3

yDoc вариант

2

этой статьи объясняет, как это можно сделать, поместив изображения в папку, доступную для инструмента javadoc.

0