Consulter les commentaires des tables et colonnes dans la documentation du code Oracle

Visual Expert (VE) 2020 supporte maintenant les commentaires ajoués aux tables et colonnes Oracle, qui sont essentiels pour documenter et expliquer le rôle d'une table ou d'une colonne particulière.

Le parseur de code Oracle de Visual Expert les analyse désormais. Les commentaires seront ensuite affichés dans l'interface utilisateur de VE, ainsi que dans la documentation du code PL/SQL Oracle.

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.

    Afficher les tables dans le treeview

  • Cliquez sur une table dans la vue principale pour vérifier les commentaires qui lui sont associés dans la vue du code source.

    Vérifier les commentaires des tables 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érifier les commentaires sur les colonnes

 

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.

    Vérifier les commentaires dans la documentation Oracle PLSQL

  • Les commentaires des tables seront affichés dans la colonne "Description".

    Vérifier les commentaires sur la table dans la documentation Oracle PLSQL

  • 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".

    Vérifier les commentaires sur les colonnes dans la documentation Oracle PLSQL

 

Visual Expert 2020, Oracle, Check Comments, Code Documentation