Génération d'une documentation Javadoc HTML comportant des images de diagrammes UML

Vous avez la possibilité de générer une documentation Javadoc HTML comportant des images de diagrammes UML (Unified Modeling Language) pour fournir plus d'informations sur le code source dans des projets Java.
A propos de cette tâche
Vous pouvez intégrer des images de diagrammes UML dans une documentation Javadoc HTML en parallèle du code source contenu dans les projets Java™ en incluant la balise @viz.diagram. Cette balise peut définir la présence d'une image de diagramme spécifique dans une documentation Javadoc HTML. Il existe un format spécifique pour ces balises : par exemple, @viz.diagram class_diagram.dnx qui permet d'insérer l'image du contenu de class_diagram.dnx dans une documentation Javadoc HTML.

Par exemple, vous pouvez indiquer à l'outil de produire une documentation Javadoc HTML pour des classes particulières, de mettre le nom de l'auteur du code en évidence et d'afficher un diagramme UML simple qui reflète certains aspects de la hiérarchie d'héritage des classes dans un projet Java. Certaines des relations d'utilisation avec d'autres classes peuvent faciliter la compréhension du code source dans le projet.

Vous pouvez générer des images de diagrammes au format bitmap (.bmp), Graphic Interchange Format (.gif) ou Joint Photographic Experts Group (.jpeg ou .jpg).


Commentaires