Construire des graphes à partir de balises de documentation

Question

Récemment, je me suis beaucoup préoccupé des "dépendances" dans les projets et les systèmes. J'ai vécu une très mauvaise expérience lorsque quelqu'un a déprécié un serveur de base de données que personne n'aurait dû utiliser dans mon entreprise.

J'ai pensé que cela ne serait pas arrivé si j'avais pu utiliser un outil, peut-être même un plug-in/extension de javadoc où l'on peut spécifier les dépendances entre les systèmes.

Quelque chose de proche du code, comme l'ajout d'une balise dans la javadoc d'une méthode qui indique que cette méthode utilise cette table dans cette base de données ou cet autre service Web dans ce serveur. Ensuite, cet outil générerait un graphique visuel avec tous les systèmes et autres.

Ainsi, vous codez la dépendance, vous ajoutez le commentaire/quelque chose dans le code et le graphique est mis à jour/généré automatiquement.

Un tel outil existe-t-il ?

Et d'ailleurs, nous avons essayé d'utiliser des wikis et autres et je peux dire par expérience qu'ils se périment assez vite. Donc, je ne pense pas qu'ils puissent être une bonne solution.

Answer 1

Dans le monde Java, les systèmes OSGi tentent d'introduire la modularité, mais si vous avez une application non modulaire assez importante, la migration peut représenter un travail considérable.

Il est possible (et même nécessaire) d'introduire des dépendances entre les modules (avec la numérotation des versions). Ces dépendances sont vérifiées tant au moment de la compilation qu'au moment de l'exécution (il est possible de remplacer des modules sans modifier les autres - mais dans ce cas, des tests sont nécessaires :D ).

Il permet de résoudre le problème que vous avez présenté, mais sa courbe d'apprentissage est assez raide, et la migration de l'application existante peut être très pénible. D'autre part, je ne connais pas d'outil capable de construire un graphe de dépendances à partir de Javadoc ou de tout autre type de documentation.