PC SOFT

DOCUMENTATION EN LIGNE
DE WINDEV, WEBDEV ET WINDEV MOBILE

  • Présentation
  • Quels sont les commentaires pris en compte ?
  • A quel moment la documentation du composant est-elle générée ?
  • Comment disposer de la documentation d'un composant ?
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaEtats et RequêtesCode Utilisateur (MCU)
WEBDEV
WindowsLinuxPHPWEBDEV - Code Navigateur
WINDEV Mobile
AndroidWidget AndroidiPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Autres
Procédures stockées
Présentation
Un composant externe doit absolument être accompagné d'une documentation pour permettre son utilisation.
WINDEV, WEBDEV et WINDEV Mobile simplifient la réalisation de cette documentation en proposant :
  • Une présentation générale du composant. Cette présentation générale est saisie lors de la génération du composant.
    Lors de l'utilisation du composant dans une application WINDEV, cette présentation sera visible lors du survol du composant affiché dans le volet "Assistants, Exemples et Composants". Pour plus de détails, consultez Gestion des composants depuis le volet "Assistants, Exemples et Composants".
  • Une génération automatique de la documentation technique à partir des commentaires insérés dans le code des éléments du composant.
Quels sont les commentaires pris en compte ?
Les commentaires pris en compte automatiquement pour la documentation du composant sont :
  • Les commentaires placés en tête des procédures WLangage.
  • Les commentaires placés en tête des traitements suivants :
    • Code d'initialisation des fenêtres ou des pages,
    • Code d'initialisation des états,
    • Code d'initialisation des classes,
    • Code d'initialisation des collections de procédures.
A quel moment la documentation du composant est-elle générée ?
La documentation du composant est générée lors de la première génération du composant (option "Atelier .. Composant Externe .. Générer un composant").La documentation du composant est générée lors de la première génération du composant : cliquez sur l'icône de génération parmi les boutons d'accès rapide.
Lors de cette génération de la documentation :
  • les commentaires existants dans le code sont utilisés pour créer la documentation.
  • si aucun commentaire n'existe, les éléments accessibles du composant seront automatiquement documentés en précisant les paramètres attendus en entrée et en sortie de chaque élément. Les commentaires correspondants sont automatiquement créés dans les différents éléments.
Remarque : A chaque re-génération du composant, il est possible de re-générer la documentation associée au composant (bouton "Regénérer").

Attention : Si vous utilisez le bouton "Regénérer", les modifications effectuées sous l'assistant de génération seront supprimées.
Comment disposer de la documentation d'un composant ?
La présentation générale du composant est automatiquement affichée lors du survol du composant présent dans le volet "Assistants, Exemples et Composants".La présentation générale du composant est automatiquement affichée dans la fenêtre de description du composant.
La documentation technique du composant est disponible :
  • lors de l'intégration d'un composant dans un projet (option "Atelier .. Composant Externe .. Importer un composant dans le projet").lors de l'intégration d'un composant dans un projet : sous le volet "Projet", dans le groupe "Projet", déroulez "Importer" et sélectionnez "Un composant externe".
    • à tout moment, dans la description des composants intégrés dans le projet (option "Atelier .. Composant Externe .. Liste des composants intégrés dans le projet"). Le bouton [Description] permet d'obtenir les informations et la documentation du composant.
    à tout moment, dans la description des composants intégrés dans le projet.
    Sous l'explorateur de projet :
    • Sélectionnez le dossier "Composants externes".
    • Affichez le menu contextuel (clic droit).
    • Sélectionnez l'option "Liste des composants intégrés dans le projet".
      Le bouton [Description] permet d'obtenir les informations et la documentation du composant.
La documentation spécifique à un élément du composant (fenêtre, ...) peut être obtenue :
  • soit en double-cliquant sur cet élément (depuis le volet "Explorateur de projet" ou le graphe du projet) ou en appuyant sur la touche F2 depuis le code de cet élément.soit en double-cliquant sur cet élément depuis le volet "Explorateur de projet" ou en appuyant sur la touche F2 depuis le code de cet élément.
  • soit directement dans la liste des composants intégrés au projet (option "Atelier .. Composant Externe .. Liste des composants intégrés dans le projet").soit depuis l'explorateur de projet :
    • sélectionnez le dossier "Composants externes".
    • Affichez le menu contextuel (clic droit).
    • Sélectionnez l'option "Liste des composants intégrés dans le projet".
Version minimum requise
  • Version 9
Documentation également disponible pour…
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire