WINDEV 2025 : Les concepts

Partie 2 : Environnement de développement 79 6 Modifier un composant externe 6.1 Présentation A tout moment, un composant créé et généré peut être modifié. Cette modification peut correspondre : • soit à l’ajout d’éléments dans le composant. • soit à la suppression d’éléments du composant. • soit à la modification des droits sur les éléments du composant. • soit à la modification d’un des éléments du com- posant. Dans tous les cas, après cette modification, le com- posant doit être re-généré pour prendre en compte les modifications effectuées. 6.2 Les différents types de compatibilité La gestion de la compatibilité est liée aux versions d’un composant. En effet, si des modifications ont été apportées au composant, les applications qui utilisent le composant en déploiement peuvent ren- contrer des problèmes d’exécution si elles ne sont pas en phase avec ce composant. La gestion de la compatibilité est une étape impor- tante dans la modification d’un composant. Il existe 2 types de compatibilité : • la compatibilité descendante  : la version du composant utilisée (fichier .WDK) pour compiler les applications utilisant ce composant doit être toujours supérieure ou égale à la version actuelle- ment utilisée en déploiement. Cette compatibilité est automatiquement gérée. Si le composant installé avec l’application est d’une version inférieure à celle utilisée par l’appli- cation, l’application refusera de fonctionner. • la compatibilité ascendante  : l’utilisation d’une nouvelle version d’un composant avec les projets compilés avec une ancienne version peut être interdite. Il est donc nécessaire de recompiler les projets pour utiliser correctement la nouvelle ver- sion du composant. 7 Caractéristiques avancées d’un composant 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.