Pour simplifier les phases de maintenance ou la reprise par d'autres développeurs de code existant, WINDEV, WEBDEV et WINDEV Mobile proposent une documentation automatique des procédures (ou méthodes de classes).

• Soit à la création d'une nouvelle procédure ou méthode.
  Vous pouvez choisir si vous voulez générer les commentaires dans la fenêtre qui s'affiche lors de la création d'une procédure ou méthode (option "Générer un commentaire d'en-tête"). Les commentaires générés respecteront le paramétrage de la documentation automatique.
• Soit grâce à l'icône (présente dans le coin haut droit de la fenêtre de code d'une procédure). Cette icône permet de générer ou de supprimer un ensemble de commentaires pour la procédure en cours.

• Synchroniser automatiquement les commentaires générés en fonction de la syntaxe des procédures. Une modification de la syntaxe entraîne la mise à jour des commentaires associés (lors de la sauvegarde).
• Utiliser la saisie assistée lors de l'écriture de l'appel aux procédures ou méthodes documentées. Pour plus de détails, consultez le paragraphe Saisie assistée.

Paramétrage

Pour paramétrer la documentation automatique :

1. Sous le volet "Accueil", dans le groupe "Environnement", déroulez "Options" et sélectionnez "Options de l'éditeur de code".
2. Affichez l'onglet "Doc.".

Important : Chaque bloc de commentaires doit respecter le format détaillé ci-dessous. En particulier, la description de chaque paramètre ainsi que la description de la valeur de retour doivent être effectuées sur une seule ligne. Dans le cas contraire, des décalages pourront être observés.

Que contiennent les commentaires ?

Le commentaire d'une fonction ou d'une procédure peut contenir les éléments suivants :

• Résumé : le commentaire correspondant est le suivant :
  
  ou
  
• Entête de description de la procédure : le commentaire correspondant est le suivant :
  
• Syntaxe d'appel : le commentaire correspondant est le suivant :
  
• Détail des paramètres : le commentaire correspondant est le suivant :
  
  ou
  
• Timer automatique : le commentaire correspondant permet de décrire le timer automatique défini pour la fonction ou la procédure :
  
• Gestion automatique des erreurs et des exceptions : le commentaire correspondant permet de décrire le mode de gestion des erreurs et des exceptions (défini via le lien "Si Erreur" dans le bandeau d'entête de la procédure). Par exemple :
  
• Note : le commentaire correspondant est le suivant :
  
  ou
  
• Exemple : le commentaire correspondant est le suivant :
  
• Marque indiquant que la procédure doit être documentée : le commentaire correspondant est le suivant :
  

Remarque : suppression de paramètres

Si un paramètre est spécifié dans la syntaxe de la procédure, puis supprimé, la référence au paramètre est toujours visible dans la section "Détail des paramètres" des commentaires.

Saisie assistée sur les procédures et méthodes de classe

Si les paramètres d'une procédure ont été documentés, et si la saisie assistée est disponible dans l'éditeur de code, lors de la saisie de l'appel à la procédure, la syntaxe et la description des paramètres apparaissent dans une bulle d'aide. Par exemple :

1. Documentation de la procédure :
   
2. Saisie assistée sur la procédure :
   

Le mécanisme de saisie assistée sur les procédures et les méthodes est identique à celui utilisé pour les fonctions WLangage. Pour plus de détails sur le paramétrage de la saisie assistée dans WINDEV, WEBDEV ou WINDEV Mobile, consultez Saisie assistée sur les fonctions WLangage.