Documentation du code dans Visual Expert Web

Le tableau de bord de la documentation de Visual Expert (VE) Web offre une interface centralisée pour la surveillance et la gestion de divers aspects des applications PowerBuilder (PB) et des bases de données. Il présente une vue détaillée des métriques clés et des activités, aidant ainsi les utilisateurs à mieux comprendre leurs projets.

Le tableau de bord Documentation du code de VE Web comporte deux sections principales :

Code Documentation Dashboard - VE Web

Section Application PB

La section PB Application affiche un récapitulatif des différents composants de votre projet PowerBuilder. Voici une description des principales icônes que vous trouverez sur le tableau de bord :

Composant Description
PBLs Organiser et gérer efficacement les composantes du projet.
Fenêtres Éléments de l'interface utilisateur graphique, tels que les dialogues et les formulaires, utilisés pour les interactions avec l'utilisateur.
User Objects Objets personnalisés créés par les développeurs pour encapsuler des fonctionnalités ou des données, pouvant être réutilisés dans l'ensemble de l'application.
DataWindows Objets gérant la récupération des données, l'affichage et l'interaction avec l'utilisateur dans les applications PowerBuilder.
Menus Éléments d'interface fournissant des options de navigation, généralement affichés sous forme de listes déroulantes.
Function Objects Méthodes ou fonctions qui exécutent des tâches spécifiques, encapsulant le code métier ou le comportement de l'application.
Structures Types de données définis par l'utilisateur regroupant des variables apparentées.
Application Objects Objets centraux gérant le démarrage, l'arrêt et le comportement général de l'application.
Global Variables Accessible à partir de n'importe quelle partie de l'application, et non limité à une fonction spécifique ou à un objet.
Global Functions Fonctions communes à l'ensemble de l'application, conçues pour des tâches générales ou des calculs.

Naviguer dans les composants PowerBuilder dans la documentation

Pour accéder aux détails d'un composant PB, cliquez sur l'icône ou la zone correspondante.

Navigating PowerBuilder Components - Documentation

Par exemple, sous les "User Objects", vous trouverez :

  1. Une liste d'objets utilisateur avec leur description.
    List of PowerBuilder User Objects - Documentation
  2. Vous pouvez obtenir des informations détaillées en cliquant sur un objet spécifique (par exemple, pfc_u_tabpg_dwproperty_srvcalendar) :
    • Informations générales
    • Hiérarchie des ancêtres
    • Variables, constantes et références
    • Objet Events
    • Objet Functions
    • Les contrôles et leurs événements
    • Code source
    • Inspection du code
    • Architecture
    PowerBuilder User Objects Details - Documentation
  3. Les icônes situées dans le coin supérieur droit permettent d'accéder à des détails supplémentaires :
  4. Technical Information of PowerBuilder User Objects - Documentation
    • Afficher toutes les informations
    • Afficher uniquement les détails de la revue de code
    • Afficher des informations techniques sur le code
  5. Dans l'arborescence, vous pouvez parcourir les icônes et cliquer sur la flèche pour faire apparaître d'autres options.
    PowerBuilder Code Documentation TreeView

Section Base de données

La section La section Base de données fournit une vue d'ensemble des principaux objets de la base de données. Voici une description des principales icônes du tableau de bord:

Database Component Description
Tables Stocker des données structurées en lignes et en colonnes pour l'organisation et la gestion.
Vues Tables virtuelles qui affichent les données interrogées dans un format spécifique sans les stocker.
Procédures Routines stockées pour effectuer des opérations telles que la manipulation de données ou l'exécution du code métier.
Fonctions Similaires aux procédures mais renvoyant une valeur, utilisées pour les calculs, le traitement des données ou d'autres opérations dans les requêtes.
Packages Ensemble de procédures, de fonctions et d'autres objets visant à améliorer l'organisation.
Triggers Procédures stockées qui s'exécutent automatiquement lors d'événements tels que des actions d'insertion, de mise à jour ou de suppression.
Sequences Génèrent des valeurs numériques uniques, habituellement utilisées comme identifiants pour les enregistrements.
Tables in Person Schema Affiche les table dans le schema "Person".
Tables in Purchase Schema Affiche les table dans le schema "Purchase".

Naviguer dans les composants de la base de données dans la documentation

Pour explorer les informations relatives à la base de données dans la documentation, cliquez sur une des zones mises en évidence.

Navigating Database Components - Documentation

Par exemple, sous Tables, vous trouverez :

  1. Une liste de tables avec leur description.
    List of PowerBuilder User Objects - Documentation
  2. Detailed information upon selecting a table (e.g., Sales_Order_Items):
    • Colonnes
    • Code source
    • Index
    • Déclencheurs
    • Inspection des codes
    • Références
    • Analyse d'impact
    Database Table Details - Documentation
  3. Cliquez sur les icônes dans le coin supérieur droit pour obtenir des détails spécifiques :
  4. Technical Information of Database Tables - Documentation
    • Afficher toutes les informations
    • Afficher uniquement les détails de la revue de code
    • Afficher des informations techniques sur le code
  5. Dans l'arborescence, vous pouvez parcourir les icônes et cliquer sur la flèche pour faire apparaître d'autres options.
    Database Code Documentation TreeView

 

Plus d'information sur la Documentation Visual Expert

Visual Expert, Documentation du code, Web, Tableau de bord, PowerBuilder, bases de données, Composants