METHODE LIRE COMMENTAIRES

4D v20 R7


METHODE LIRE COMMENTAIRES ( chemin ; commentaires {; *} )

Paramètre	Type	Description
chemin	Texte, Tableau texte	Texte ou Tableau texte contenant un ou plusieurs chemin(s) de méthode(s)
commentaires	Texte, Tableau texte	Documentation de la ou des méthode(s) désignée(s)
*	Opérateur	Si passé = la commande s’applique à la base hôte lorsqu’elle est exécutée depuis un composant (paramètre ignoré hors de ce contexte)

Description

La commande METHODE LIRE COMMENTAIRES retourne dans le paramètre commentaires la documentation de la ou des méthode(s) désignée(s) par le paramètre chemin.

La documentation lue par cette commande est affichée dans l’Explorateur de 4D (à ne pas confondre avec les lignes de commentaires dans le code, qui peuvent être lues à l’aide de METHODE LIRE CODE).

Elle contient :

du texte markdown dans les bases projet
du texte stylé dans les bases binaires

Cette documentation peut être générée pour des méthodes de type triggers, méthodes projet, méthodes formulaire, méthodes base ou les classes.

Note : Les formulaires et les méthodes formulaire partagent la même documentation.

Vous pouvez utiliser deux types de syntaxes, basées soit sur des tableaux texte, soit sur des variables texte :

 C_TEXTE(vTchemin) // variables texte

 C_TEXTE(vTcommentaires)

 METHODE LIRE COMMENTAIRES(vTchemin;vTcommentaires) // documentation d’une seule méthode

 TABLEAU TEXTE(tabChemins;0) // tableaux texte

 TABLEAU TEXTE(tabCommentaires;0)

 METHODE LIRE COMMENTAIRES(tabChemins;tabCommentaires) // documentation de plusieurs méthodes

Il n’est pas possible de mixer les deux syntaxes.

Si la commande est exécutée depuis un composant, elle s’applique par défaut aux méthodes du composant. Si vous passez le paramètre *, elle accède aux méthodes de la base hôte.

Voir aussi

METHODE FIXER COMMENTAIRES