Quelle est la façon la plus courante d'intégrer UML dans le code Java?
J'essaie d'ajouter des diagrammes de séquence UML et de classe à mon code Java, afin d'expliquer ses composants internes et ses concepts de conception. Je voudrais que ces diagrammes soient spécifiés dans des blocs JavaDoc, puis convertis en images PNG/GIF attachées à l'API HTML.
Quel outil je peux utiliser pour l'automatisation de ce processus (j'utilise Maven 3)?
2 answers
Diagrammes UML dans Javadocs : Cet article montre à quel point il est facile et simple d'inclure des diagrammes UML dans votre Javadoc et de les tenir à jour à chaque changement dans le référentiel de code source.
Je pense que le modèle devrait être mis à jour et pas seulement les diagrammes convertis en PNG/GIF, etc.... Produire un diagramme automatique n'a pas de valeur réelle. Quel est l'intérêt de montrer par exemple une classe énorme et toutes ses méthodes (par exemple parfois plus de 100) dans un seul diagramme généré automatiquement ? Vous pourriez obtenir un diagramme énorme et ne pas comprendre pourquoi ce code a été écrit et ne pouvait pas comprendre l'architecture, etc...Vous voyez juste une vue graphique de votre code qui n'est pas l'objectif d'UML !!
Ce que je fais dans mes projets pour mon code est d'utiliser les fonctionnalités suivantes:
-
Le afficher masquer javadoc afficher java doc dans mon diagramme de classe UML
J'utilise aussi le contraire de la méthode afin d'obtenir un diagramme de séquence.
Ce que j'apprécie le plus, c'est de pouvoir vivre la navigation dans le code, puis extraire mon modèle et ne naviguer que dans le modèle. Je peux modéliser ce que je veux et essayer de nouvelles architectures avant de lui donner le développeur Equipe.
Je pense que la génération automatique de diagrammes à inclure dans JavaDoc n'est pas ce qui devrait être fait. Si vous ne passez que 5 minutes manuellement, vous pourrez mettre à jour votre modèle existant avec toutes les modifications. Vous pourrez créer des vues UML personnalisées dans lesquelles vous pourrez ajouter des commentaires. Avoir des vues fournira de meilleures informations à l'équipe tout en gagnant du temps et en ajoutant de la qualité au code.
Ce que vous pouvez faire est de fournir une visionneuse UML pour chaque développeur et un lien dans votre JavaDoc. Le développeur n'aura qu'à cliquer sur le lien et pourra ouvrir le diagramme qui sera automatiquement mis à jour. Plus d'exportation d'image douloureuse, mauvaise mise à jour car une fois l'image créée, il est impossible de la changer. Vous pouvez toujours créer de nouvelles images, mais vous perdez vos commentaires, présentation, etc..... et n'obtenez qu'un énorme diagramme statique comprenant toutes les méthodes, attributs, etc...ne pas pouvoir détecter une association avancée et dépendance. Seule la détection des héritages est correcte !!
Votre modèle UML pourrait être utilisé avec maven et SVN et apporter une valeur réelle à votre projet et à votre modélisation, ce qui ne peut pas être réalisé par l'exportation d'images. Il me semble que vous essayez d'utiliser des diagrammes UML juste pour ajouter UML à votre projet mais en ajoutant l'exportation d'image d'un projet mal inversé sans vues, commentaires etc...is pas UML et n'a aucune valeur dans un projet Java