|
|
|
|
|
|
|
|
|
|
- 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 ?
Documentation automatique des composants externes
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.
- 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 événements 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 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 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 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 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 : 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.
Dans le volet "Explorateur de projet" : - Dans le dossier "Composants externes", sélectionnez 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 externes".
- Affichez le menu contextuel (clic droit).
- Sélectionnez l'option "Liste des composants externes importés dans le projet".
Documentation également disponible pour…
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|