2009-09-11 27 views
23

C'è un modo per incorporare immagini nel mio JavaDoc? Fondamentalmente voglio includere alcuni diagrammi UML che spiegano la gerarchia delle mie classi in alcuni documenti.Javadoc Inserimento di diagrammi UML

Grazie!

+0

+1 Vorrei avrei chiesto io stesso! – KLE

risposta

22

Consultare this section della documentazione Javadoc, che spiega come incorporare le immagini nel Javadoc.

Inoltre, ecco un article che descrive come eseguire il reverse engineering dei diagrammi UML e incorporarli in Javadoc utilizzando UMLGraph.

8

Sì.

The documentation spiega come incorporare immagini arbitrarie nella documentazione di javadoc.

Se si desidera generare diagrammi di classi UML dalla propria origine Java, dare un'occhiata allo UMLGraph doclet.

+0

+1 grazie mille. Ho bisogno di imparare e usare questo !! – KLE

+0

Anche questo articolo sull'utilizzo del grafico UML http://java.dzone.com/articles/reverse-engineer-source-code-u – pjp

0

Questo article spiega come può essere fatto posizionando le immagini in una cartella accessibile allo strumento javadoc.

2

yDoc è un'opzione

+1

USD 269,00 per una licenza per utente singolo. – liftarn

+0

C'è un'alternativa OpenSource/gratuita per C#? – hellboy

3

This article mostra come utilizzare UMLGraph con Maven plug Javadoc.

In breve:

  1. Installa GraphViz.

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

  2. Aggiornamento 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. Run mvn javadoc:javadoc.

+1

Chiaramente l'approccio più semplice! Dovresti aggiungere un profilo per costruirli in modo da non rompere le altre build di ppl che non hanno GraphViz nel percorso. –

3

Risposta semplice:

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