4D v19
METHOD SET COMMENTS
- 4D - Langage
-
- Accès objets développement
-
- Commandes du thème Accès objets développement
- Current method path
- FORM EDIT
- FORM GET NAMES
- METHOD Get attribute
- METHOD GET ATTRIBUTES
- METHOD GET CODE
- METHOD GET COMMENTS
- METHOD GET FOLDERS
- METHOD GET MODIFICATION DATE
- METHOD GET NAMES
- METHOD Get path
- METHOD GET PATHS
- METHOD GET PATHS FORM
- METHOD OPEN PATHMod
- METHOD RESOLVE PATH
- METHOD SET ACCESS MODE
- METHOD SET ATTRIBUTE
- METHOD SET ATTRIBUTES
- METHOD SET CODE
- METHOD SET COMMENTS
METHOD SET COMMENTS
| METHOD SET COMMENTS ( 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(s) 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) | |||||
La commande METHOD SET COMMENTS remplace la documentation de la ou des méthode(s) désignée(s) par le paramètre chemin par ceux définis dans le paramètre commentaires.
La documentation modifiée par cette commande est affichée dans l’Explorateur de 4D (à ne pas confondre avec les lignes de commentaires dans le code). Ils contiennent du texte stylé. 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 les méthodes de type trigger, 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_TEXT(vTchemin) // variables texte
C_TEXT(vTcommentaires)
METHOD SET COMMENTS(vTchemin;vTcommentaires) // documentation d’une seule méthode ARRAY TEXT(tabChemins;0) // tableaux texte
ARRAY TEXT(tabCommentaires;0)
METHOD SET COMMENTS(tabChemins;tabCommentaires) // documentation de plusieurs méthodesIl n’est pas possible de mixer les deux syntaxes.
Si un chemin d’accès passé est invalide, une erreur est générée.
Vous pouvez exécuter cette commande depuis un composant, mais dans ce cas vous devez passer le paramètre * car l’accès en écriture au code du composant n’est pas possible. Si vous omettez le paramètre * dans ce contexte, l’erreur -9763 est générée.
Ajout d’une date de modification à une documentation de trigger existante :
METHOD GET COMMENTS("[trigger]/Table1";$comments)
$comments:="Modif :"+String(Date du jour)+"\r"+$comments
METHOD SET COMMENTS("[trigger]/Table1";$comments)
Produit : 4D
Thème : Accès objets développement
Numéro :
1193
Créé : 4D v13
4D - Langage ( 4D v19)
4D - Langage ( 4D v19.1)
