yWorks UML Doclet

Das yWorks UML Doclet, bisher yDoc genannt, ist eine Javadoc™ Erweiterung, die automatisch klare und übersichtliche UML Diagramme von den Klassen Ihres Software Projekts generiert und diese in die erzeugte Java API Dokumentation integriert.

yWorks UML Doclet bedient sich der ausgezeichneten Layoutalgorithmen unserer Visualisierungsbibliothek yFiles, um die UML-Diagramme zu erzeugen.

Jetzt voll funktionsfähige Community Edition frei verfügbar.

Neue Merkmale in Version 3.0

• Neuer Übersichtsdiagrammtyp, der die Vererbungsstruktur von Klassen und Schnittstellen über Paketgrenzen hinweg zeigt.
• UML Diagramme können im SWF (Shockwave Flash) Dateiformat erzeugt werden.
• Neue Stiloptionen, um die Darstellung von Diagrammelementen zu beeinflussen.
• Eigene Diagramme (im GraphML Dateiformat) können in die generierte Dokumentation eingebunden werden.
• Neue XML-basierte Konfiguration.
• Viele neue Layoutoptionen für Übersichtsdiagrammtypen.
• Neue Ausrichtungsoptionen für Assoziationen und Abhängigkeiten in Klassendiagrammen.
• StyleEd wurde erheblich verbessert und nutzt die neue XML-basierte Konfiguration. Die Anwendung ermöglicht einfaches Testen von Stil- und Layoutoptionen.

Bitte beachten Sie die yWorks UML Doclet Versionsinformationen, um mehr über die Produktverbesserungen dieser Version zu erfahren.

Herausragende Merkmale

Die Liste der yWorks UML Doclet Merkmale beinhaltet:

• Einen XML-basierten Mechanismus, um eigene Javadoc-Tags zu definieren.
• Die Möglichkeit gezielt Klassen, Methoden und Felder von der Dokumentation auszuschließen. Dies wird einfach durch einen Exklusions-Tag an den unerwünschten Klassen, Methoden oder Feldern erreicht. Darüberhinaus stellen wir ein Interface zur Verfügung, das den Einsatz von anspruchsvollen und individuellen Exklusionskriterien erlaubt.
• Automatische Generierung von UML Diagrammen für alle dokumentierten Klassen und Pakete.
  • Die Diagramme können als SVG (Scalable Vector Graphics), SWF, PNG, GIF oder JPG in die erzeugten HTML-Seiten eingebunden werden.
  • Alle Diagramme sind mit Hyperlinks hinterlegt, die direkt auf die Dokumentation der dargestellten Pakete, Typen, Methoden und Felder verweisen.
  • Alle Diagramme können über Stildefinitionen an Benutzerwünsche angepasst werden.

• StyleEd, ein einfach zu bedienender Editor mit graphischer Oberfläche zum Erstellen von Diagrammstilen:

• Unterstützung für Java 5.0 Spracherweiterungen:
  • Namen von parametrisierten Typen werden vollständig angezeigt.
  • Typsichere Aufzählungen werden als Klassen mit enum constraint-Markierung dargestellt.
  • Annotationstypen werden als Interfaces mit annotation Stereotypen-Markierung dargestellt.
  • Variable Parameterlisten werden erkannt und als ... dargestellt.

Beispiele

UML Klassendiagramme, die von yWorks UML Doclet erzeugt werden, zeigen Generalisierungs- und Realisierungsbeziehungen ebenso wie Assoziationen und Abhängigkeiten zwischen Klassen und Schnittstellen.
Die Darstellung von Diagrammelementen kann dabei mit Hilfe vorgegebener bzw. Benutzer-definierter Stile einfach angepasst werden.
Ein real-world Beispiel aus der yFiles API Dokumentation ist etwa dieses Klassendiagramm für eine der Klassen der yFiles Bibliothek.

original Stil		gradient Stil		dark-matter Stil
dotnet Stil		muted-colors Stil		yFiles Stil

Die von yWorks UML Doclet erzeugten Paketdiagramme verdeutlichen die Klassenhierarchie in den Paketen. Über die Stildefinitionen und viele Layoutoptionen kann das Aussehen der Diagramme einfach angepasst werden; u.a. sind verschiedene Layoutrichtungen möglich.
Ein real-world Beispiel aus der yFiles API Dokumentation ist etwa dieses Paketdiagramm für eines der Pakete der yFiles Bibliothek.

Layoutrichtung links-nach-rechts
gradient Stil		dotnet Stil
Layoutrichtung unten-nach-oben
original Stil		theBlues Stil

Mit den Übersichtsdiagrammen, die von yWorks UML Doclet erzeugt werden können, lassen sich Abhängigkeiten von Paketen untereinander bzw. die Vererbungsstruktur von Klassen und Schnittstellen über Paketgrenzen hinweg veranschaulichen:
Real-world Beispiele aus der yFiles API Dokumentation sind etwa die Übersichtsdiagramme für die Pakete der yFiles Bibliothek.

Paketabhängigkeiten

Vererbungsstruktur über Paketgrenzen hinweg

Dokumentation

• yWorks UML Doclet Installations- und Benutzerhandbuch HTML Version, PDF Version (englisch)
• API Dokumentation der DocFilter Klasse (englisch)
• Knowledge Base Artikel (online, englisch) zu yWorks UML Doclet, die häufig gestellte Fragen beantworten, oder Lösungen für bestimmte Sachverhalte präsentieren

Voraussetzungen

yWorks UML Doclet benötigt das Javadoc-Tool von JDK 1.5.0 / 1.6.0 / 1.7.0.

Damit Ihr HTML-Browser die in der API Dokumentation eingebetteten UML-Klassendiagramme im SVG Format anzeigen kann, benötigen Sie ein SVG-Plugin. Für den Microsoft Internet Explorer kann man ein solches bei Adobe kostenfrei herunterladen.

Damit Ihr HTML-Browser die in der API Dokumentation eingebetteten UML-Klassendiagramme im SWF Format anzeigen kann, benötigen Sie das Adobe Flash Player-Plugin. Dieses kann bei Adobe kostenfrei heruntergeladen werden.

yWorks UML Doclet Editionen

yWorks UML Doclet ist erhältlich als kostenlose Community Edition und als Professional Edition.

Für yWorks UML Doclet Professional Edition bieten wir Single User-, Server- und Department-Lizenzen an. Alle Lizenzen beinhalten freie Upgrades und technischen Support innerhalb eines Jahres nach Ausstellungsdatum.

Die folgende Tabelle bietet eine Gegenüberstellung von yWorks UML Doclet Community Edition und Professional Edition.