WEBDEV 2024 : Les concepts

110 Partie 3 : Environnement de développement 7 Caractéristiques avancées d’un composant externe 7.1 Documentation automatique Un composant externe doit absolument être accom- pagné d’une documentation pour permettre son uti- lisation. 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éra- tion du composant. • Une génération automatique de la documenta- tion technique à partir des commentaires insérés dans le code des éléments du composant. Quels sont les commentaires de code pris en compte ? Les commentaires pris en compte automatique- ment 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 événe- ments 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 est-elle générée ? La documentation du composant est créée lors de la première génération du composant ( 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 ac- cessibles du composant seront automatiquement documentés en précisant les paramètres atten- dus en entrée et en sortie de chaque élément. Les commentaires correspondants sont automa- tiquement 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 asso- ciée au composant (bouton "Regénérer"). Attention  : Si vous utilisez le bouton "Regénérer", les modifications de la documentation effectuées dans 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 auto- matiquement affichée dans la fenêtre de descrip- tion du composant. La documentation technique du composant est disponible : • lors de l’intégration d’un composant dans un pro- jet : sous le volet "Projet", dans le groupe "Projet", déroulez "Importer" et sélectionnez "Un compo- sant externe". • à tout moment, dans la description des compo- sants intégrés dans le projet. Dans le volet "Explorateur de projet" : • Dans le dossier "Composants externes", sélec- tionnez le composant externe voulu. • Affichez le menu contextuel (clic droit) et sélectionnez l’option "Description". • L’onglet "Détail" permet d’obtenir le détail de la documentation générée. 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 en appuyant sur la touche F2 depuis le code de cet élément. • soit depuis le volet "Explorateur de projet" : • Sélectionnez le dossier "Composants ex- ternes". • Affichez le menu contextuel (clic droit). • Sélectionnez l’option "Liste des composants externes importés dans le projet". 7.2 Visibilité d’un élément d’un composant Lors de la création d’un composant, il est possible de définir les éléments du composant qui seront acces- sibles ou non par l’utilisateur du composant. • Si l’élément est accessible, l’utilisateur du compo- sant verra cet élément dans la liste des éléments du projet. Il pourra manipuler ces éléments par programmation (comme s’il s’agissait d’un élé- ment créé dans le projet). Remarque  : Le code de cet élément n’est cepen- dant pas visible.