java - software - programa para hacer diagramas de clases

Javadoc Insertando Diagramas UML

Question

¿Hay alguna manera de incrustar imágenes en mi JavaDoc? Básicamente, quiero incluir algunos diagramas UML que expliquen la jerarquía de mis clases en parte de la documentación.

¡Gracias!

Answer 1

Consulte esta sección de la documentación de Javadoc, que explica cómo incrustar imágenes en su Javadoc.

Además, aquí hay un article describe cómo aplicar ingeniería inversa a los diagramas UML e incrustarlos en su Javadoc utilizando UMLGraph .

Answer 2

Este artículo explica cómo se puede hacer al colocar sus imágenes en una carpeta a la que puede acceder la herramienta javadoc.

Answer 3

Respuesta simple:

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

Answer 4

Sí.

La documentación explica cómo incrustar imágenes arbitrarias en la documentación de javadoc.

Si desea generar diagramas de clase UML desde su fuente Java, eche un vistazo al doclet UMLGraph .

Answer 5

ApiViz es un buen doclet también.

Answer 6

Este artículo muestra cómo utilizar UMLGraph con el complemento Javadoc de Maven.

En breve:

1. Instale GraphViz.

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

2. Actualizar 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. Ejecute mvn javadoc:javadoc .

Answer 7

yDoc es una opción