Concepts de WINDEV - Source : www.pcsoft-windev-webdev.com

7 Caractéristiques avancées d’un composant7.1 Documentation automatiqueUn composant doit absolument être accompagnéd'une documentation pour permettre sa ré-utilisation.WinDev simplifie la réalisation de cette documentationen proposant :• une présentation générale du composant. Cetteprésentation générale est saisie lors de la générationdu composant. Lors de l'utilisation du composantdans une application WinDev, cetteprésentation sera visible lors du survol du composantaffiché dans le volet "Assistants, Exempleset Composants". Pour plus de détails,consultez l’aide en ligne.• une génération automatique de la documentationtechnique à partir des commentaires insérésdans le code des éléments du composant.Quels sont les commentaires de codepris en compte ?Les commentaires pris en compte automatiquementpour la documentation du composant sont :• Les commentaires placés en tête des procéduresWLangage• les commentaires placés en tête des traitementssuivants :•Code d'initialisation des fenêtres•Code d'initialisation des états•Code d'initialisation des classes•Code d'initialisation des collections de procédures.A quel moment la documentationest-elle générée ?La documentation du composant est générée lorsde la première génération du composant (option"Atelier .. Composant .. Générer un composant").Lors de cette génération de la documentation :• les commentaires existants dans le code sont utiliséspour créer la documentation.• si aucun commentaire n'existe, WinDev documenteraautomatiquement les éléments accessiblesdu composant en précisant les paramètresattendus en entrée et en sortie de chaque élément.Les commentaires correspondants sontautomatiquement 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éeau composant (bouton "Regénérer" dans lafenêtre "Historique du composant").Attention : Si vous utilisez le bouton "Regénérer",les modifications effectuées sous l'assistant degénération seront supprimées.Comment disposer de la documentationd’un composant ?La présentation générale du composant est automatiquementaffichée lors du survol du composantprésent dans le volet "Assistants, Exemples et Composants".La documentation technique du composant estdisponible :• lors de l'intégration d'un composant dans un projet(option "Atelier .. Composant Externe .. Importerun composant dans le projet").• à tout moment, lors d’un double-clic sur l’icônedu composant présent dans le volet "Assistants,Exemples et Composants" ou par l’option "Description"du menu contextuel du composant.•à tout moment, dans la description des composantsintégrés dans le projet (option "Atelier ..Composant Externe .. Liste des composants intégrésdans le projet"). Le bouton "Description" permetd'obtenir les informations et ladocumentation du composant.La documentation spécifique à un élément ducomposant peut être obtenue :•soit en double-cliquant sur cet élément (volet"Explorateur de projet" ou graphe du projet) ou enappuyant sur la touche [F2] depuis le code de cetélément.• soit directement dans la liste des composantsintégrés au projet (option "Atelier .. ComposantExterne .. Liste des composants intégrés dans leprojet").Partie 2 : Environnement de développement 77