Génération automatique de documentation HTML Javadoc avec des images de diagramme UML

Vous pouvez générer automatiquement une documentation HTML Javadoc contenant des images de diagramme UML en utilisant les formats et options Javadoc par défaut.
Avant de commencer
Vous devez avoir installé un kit JDK (Java™ Development Kit), version 1.4.2 ou ultérieure, contenant un fichier exécutable Javadoc.
A propos de cette tâche
Pour générer automatiquement une documentation HTML Javadoc avec des images de diagramme UML, effectuez les étapes suivantes :
  1. Dans la vue Explorateur de packages, sélectionnez un projet Java et cliquez sur Projet > Générer Javadoc avec diagrammes > Automatiquement.
  2. Dans l'assistant Générer le Javadoc, sous Commande Javadoc, sélectionnez la commande Javadoc (fichier exécutable).
    Remarque : Seul un kit JDK Sun version 1.4.2 ou ultérieure est entièrement pris en charge et garantit que vous sélectionnez le fichier exécutable Javadoc approprié livré avec le kit JDK Sun.
  3. Sous Diagrammes, effectuez l'une des actions suivantes :
    • Pour inclure des images de diagramme pour les packages, cliquez sur Pour les packages. Chaque page récapitulative de package contient un diagramme illustrant le contenu du package.
    • Pour inclure des images de diagramme pour les types Java, cliquez sur Pour les types. Chaque page récapitulative de type Java (classe ou interface) contient un diagramme illustrant les types internes, les utilisations, les implémentations et les extensions de premier niveau.
    • Sélectionnez un type d'image. Les formats disponibles sont : GIF, JPG et BMP.
  4. Pour incorporer les balises d'image de diagramme dans le code source, cliquez sur Contribution de diagrammes et de balises de diagrammes dans la source.
  5. Cliquez sur Terminer.
Que faire ensuite
Remarque : Ceci insère les balises d'image de diagramme UML dans votre code source. Vous pouvez maintenant générer la documentation HTML Javadoc en cliquant sur Projet > Générer Javadoc avec diagrammes > A partir des balises existantes.

Commentaires