Les commentaires sont essentiels pour documenter et expliquer l'objectif d'une table ou d'une colonne particulière.
L'analyseur de code Oracle de Visual Expert permet de les analyser. Les commentaires apparaissent dans l'interface utilisateur de VE, ainsi que dans la documentation du code Oracle PL/SQL..
Vérifier les commentaires dans la vue principale
- Pour afficher les commentaires des tables, sélectionnez "Tables" à la racine du treeview.
Cliquez sur "Toutes les tables" dans la barre de navigation.
Les commentaires sont affichés (si disponibles) à côté de chaque nom de table.
- Cliquez sur une table dans la vue principale pour vérifier les commentaires qui lui sont associés dans la vue du code source.
- Pour vérifier les Commentaires sur les colonnes, sélectionnez une table et cliquez sur "Colonnes" dans la barre de navigation.
Vérifiez les commentaires dans la documentation
Reportez-vous à cet article pour savoir comment générer une documentation de code Oracle PL/SQL avec Visual Expert.
Une fois la documentation générée, suivez les étapes suivantes :
- Ouvrez la documentation de code générée par Visual Expert.
- Dans le tableau de bord, cliquez sur "Tables" pour afficher la liste des tables de votre application.
- Les commentaires des tables seront affichés dans la colonne "Description".
- Pour vérifier les commentaires des colonnes, cliquez sur le nom d'une table dans la liste des tables.
Ses colonnes sont listées dans la page de détails de la table, avec les commentaires associés dans la colonne "Description".
