Подтвердить что ты не робот

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

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

Спасибо!

4b9b3361

Ответ 1

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

Кроме того, здесь представлен article, в котором описывается, как перепроектировать диаграммы UML и внедрить их в ваш Javadoc, используя UMLGraph.

Ответ 2

Да.

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

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

Ответ 3

ApiViz является хорошим доклетом тоже.

Ответ 4

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

Короче:

  • Установите GraphViz.

    Ubuntu: apt-get install graphviz4.
    Windows: download.

  • Обновить 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>
    
  • Запустите mvn javadoc:javadoc.

Ответ 5

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

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

Ответ 6

yDoc является опцией