Utiliser les commentaires

Vous pouvez associer des commentaires aux objets de votre base de données. L’utilisation d’un système de commentaires est particulièrement adaptée au développement de bases à plusieurs programmeurs ainsi que, plus généralement, à la maintenance du code de vos bases.

Les types d’objets pouvant être commentés sont les suivants :

• dossiers
• méthodes (base, composant, projet, triggers et formulaire),
• formulaires,
• tables,
• champs,
• plug-ins.

Un commentaire 4D se présente sous la forme d’un texte (pouvant comporter des caractères gras, des couleurs différentes, etc.) modifiable et visualisable à tout moment dans l’Explorateur. Il peut contenir une description de l’objet auquel il est associé, ainsi que toute information nécessaire à la compréhension du fonctionnement de la base. Les commentaires sont stockés dans la structure de la base.

En outre, vous pouvez générer des commentaires automatiques, c’est-à-dire dont le contenu est mis à jour automatiquement par 4D lorsqu’un objet est créé ou modifié.

Note de compatibilité : Depuis la version 12 de 4D, les commentaires insérés dans l'en-tête d'une méthode via les caractères // sont affichés sous forme d'infobulles lorsque la méthode est référencée dans une autre méthode (cf. paragraphe "Utiliser les infobulles" dans la section WA SET EXTERNAL LINKS FILTERS). Cette fonction, très utile pour documenter les méthodes utilisateur, n'est pas compatible avec les commentaires placés dans l'Explorateur. Si vous souhaitez utiliser les en-têtes des méthodes en tant que zones de documentation, ne saisissez pas de commentaires dans l'Explorareur.

Pour ajouter un commentaire, lorsque la zone de prévisualisation est affichée, sélectionnez un objet dans la liste de l’Explorateur et cliquez sur le bouton Commentaires situé au-dessous de la zone d’aperçu.

Lorsque la zone de commentaires est affichée, il vous suffit de saisir ou de modifier du texte.

4D Server : L’icône de verrouillage située en bas à gauche de la zone indique si le commentaire est déjà édité par un autre utilisateur. Si c’est le cas, le crayon est barré et le commentaire est accessible en visualisation uniquement.

Le texte est sauvegardé dès que vous cliquez en-dehors de la zone de saisie. Vous pouvez saisir jusqu’à 32700 caractères de commentaires par objet.
Vous pouvez utiliser dans la zone de commentaires les commandes standard d’édition de texte (Copier, Coller, Tout sélectionner, etc.) disponibles dans le menu contextuel ou par raccourci-clavier. Les touches de déplacement du clavier sont également utilisables.

Vous pouvez enrichir le style des commentaires (ajouter du gras, de l’italique), changer la police des caractères ou sa couleur :

1. Dans la zone de commentaires, sélectionnez le texte que vous souhaitez modifier.
2. Cliquez dans la zone avec le bouton droit de la souris.
   Un pop up menu hiérarchique s’affiche :
   
3. Sélectionnez les attributs graphiques de votre choix.

Il est possible d’activer un système de commentaires automatiques — pour les méthodes et les formulaires de la base de données uniquement. Lorsque ce système est activé, un commentaire est automatiquement associé à chaque méthode ou formulaire créé(e) ou modifié(e) dans la base. Un commentaire automatique peut comporter du texte statique (par exemple “Modifié par...”) et des éléments variables (date, heure et utilisateur courant tel que défini dans la table des mots de passe de 4D).

Les commentaires automatiques sont définis dans la boîte de dialogue des Propriétés de la base, Page Général (cf. paragraphe ). Vous les visualisez, comme les commentaires standard, dans l’Explorateur.

Pour activer le système de commentaires automatiques :

1. Affichez la boîte de dialogue des Propriétés via la commande Propriétés de la base... du menu Développement ou le bouton correspondant de la barre d'outils de 4D.
2. Dans la page Général, cochez l’option Activer les commentaires auto. 
3. Saisissez le texte des commentaires.
   Vous pouvez insérer des textes fixes et des éléments variables. Pour l’insertion des éléments variables, vous pouvez utiliser les boutons Date, Heure et Utilisateur situés sous la zone. Vous pouvez également saisir directement les variables suivantes :
   #D pour la date
   #H pour l’heure
   #N pour l’utilisateur courant

Par exemple, si vous insérez les valeurs suivantes :

La zone de commentaire de chaque méthode ou formulaire créé(e) ou modifié(e) sera mise à jour dans l’Explorateur :

Note : Si la base ne comporte pas de système de mots de passe, #N retourne la chaîne Super_Utilisateur.

4D Server : Le paramétrage des commentaires automatiques peut être modifié par tout poste client ayant accès aux Propriétés de la base. Il est aussi possible de modifier ces paramètres dans les Propriétés de la base sur le poste serveur. Toute modification effectuée dans la page des commentaires automatiques est immédiatement prise en compte par chaque poste client, dès qu’il modifie un objet commenté.