Fonctionnalité de génération de la documentation
Remonter à Introduction aux concepts de modélisation
La fonctionnalité de génération de la documentation de la modélisation génère automatiquement la documentation pour vos projets de modélisation UML. Utilisez cette fonctionnalité pour illustrer vos programmes avec une documentation au format HTML. Vous pouvez mettre à jour cette documentation générée automatiquement quand votre projet est modifié, ou modifier cette documentation manuellement plus tard.
Fichiers de la documentation
Tous les fichiers de la documentation générée sont écrits dans un répertoire de documentation unique que vous spécifiez dans le champ Dossier de sortie de la boîte de dialogue Générer la documentation. Par défaut, la documentation générée s'ouvre dans votre navigateur web. Si vous choisissez de ne pas ouvrir la documentation immédiatement, vous pourrez l'ouvrir par la suite en utilisant le fichier INDEX.HTML du répertoire de documentation spécifié.
Cadres de la documentation HTML
La documentation HTML comporte les cadres suivants :
- Cadre Diagramme, quand l'option Inclure les diagrammes est activée.
- Cadres Projet et Vue globale, lorsque l'option Inclure l'arborescence de navigation est activée.
- Cadres Liste des packages et Vue globale des packages s'affichent sur le côté gauche du frameset principal, lorsque l'option Inclure l'arborescence de navigation est désactivée.
- Cadre Documentation.
Vous pouvez cliquer sur l'onglet Projet et développer les noeuds dans l'arborescence de la vue projet. Remarquez comment le fait de cliquer sur un nom de classe dans l'onglet Projet ouvre la documentation dans le volet Documentation. Lorsque vous sélectionnez un diagramme dans l'onglet Projet, il s'ouvre dans le cadre Diagrammes. Les éléments du cadre Diagramme sont liés par hyperlien au cadre Documentation. Si vous sélectionnez un élément dans le cadre Diagramme, son contenu est affiché dans le cadre Documentation.
Le cadre Documentation affiche la documentation de votre code source et de vos diagrammes, et il inclut tout ce dont vous pourriez avoir besoin lors de la génération de la documentation HTML. La partie supérieure du cadre Documentation contient une barre de navigation vous permettant de parcourir la documentation de votre projet.
L'onglet Projet contient une représentation arborescente du projet. Développez les noeuds pour afficher les diagrammes et les éléments individuels. Cliquer sur une classe ou une interface a pour effet d'ouvrir la documentation associée dans le cadre Documentation.