Fonction/doc

Dernière version du 8 mars 2020 à 15:04

Documentation

[purger]

Ce modèle affiche la description d’une fonction du support LUA.

Usage

Ce modèle est utilisé en entrant :

{{fonction|nom= |syntaxe= |desc= |args= |renvoie= |exemples= }}

Paramètres

nom: Le nom de la fonction.

syntaxe: La syntaxe d’utilisation de la fonction.

desc: Une brève description de la fonction.

args (optionnel): Les arguments de la fonction.; Ne l’afficher que si la fonction en question a des arguments.; Utiliser le modèle fonction arg pour compléter ce paramètre.

renvoie (optionnel): Ce que renvoie la fonction.; Ne l’afficher que si la fonction en question renvoie des informations.; Utiliser le modèle fonction renvoi pour compléter ce paramètre.

exemples (optionnel): Des exemples d’utilisation de la fonction.; Toujours essayer de donner au moins un exemple pour simplifier la compréhension par l’utilisateur.; Utiliser le modèle fonction exemple pour compléter ce paramètre.

Ceci est une page documentaire, elle devrait être transcluse dans le modèle principal. Voir Modèle:Doc pour de plus amples renseignements.

@@ Ligne 1 : / Ligne 1 : @@
-{{Doc/début}}
+{{doc/début}}
-Ce modèle affiche la description d'une fonction dans le support LUA.
+Ce modèle affiche la description d’une fonction du support LUA.
 == Usage ==
 Ce modèle est utilisé en entrant :
- <nowiki>{{Fonction
+{{tlx|fonction|nom|syntaxe|desc|args|renvoie|exemples|multiligne=1|ancres=1}}
- | nom =
- | syntaxe =
- | desc =
- | args =
- | rets =
- | exemples =
-}}</nowiki>
 == Paramètres ==
-; ''nom''
+; ''{{ancre|nom}}''
 : Le nom de la fonction.
-; ''syntaxe''
+; ''{{ancre|syntaxe}}''
-: La syntaxe d'utilisation de la fonction.
+: La syntaxe d’utilisation de la fonction.
-; ''desc''
+; ''{{ancre|desc}}''
 : Une brève description de la fonction.
-; ''args (optionnel)''
+; ''{{ancre|args}} (optionnel)''
 : Les arguments de la fonction.
-: Le tableau est omis si ce paramètre n'est pas entré. Affichez-le uniquement si la fonction en question possède des arguments.
+: Ne l’afficher que si la fonction en question a des arguments.
-: Utiliser le modèle [[Modèle:ArgFonction|ArgFonction]] pour compléter ce paramètre.
+: Utiliser le modèle [[modèle:fonction arg|fonction arg]] pour compléter ce paramètre.
-; ''rets (optionnel)''
+; ''{{ancre|renvoie}} (optionnel)''
-: Les renvois de la fonction.
+: Ce que renvoie la fonction.
-: Le tableau est omis si ce paramètre n'est pas entré. Affichez-le uniquement si la fonction en question renvoie des informations.
+: Ne l’afficher que si la fonction en question renvoie des informations.
-: Utiliser le modèle [[Modèle:RetFonction|RetFonction]] pour compléter ce paramètre.
+: Utiliser le modèle [[modèle:fonction renvoi|fonction renvoi]] pour compléter ce paramètre.
-; ''exemples (optionnel)''
+; ''{{ancre|exemples}} (optionnel)''
-: Des exemples d'utilisation de la fonction.
+: Des exemples d’utilisation de la fonction.
-: Le tableau est omis si ce paramètre n'est pas entré. Essayez toujours de donner au moins un exemple pour simplifier la compréhension de l'utilisateur.
+: Toujours essayer de donner au moins un exemple pour simplifier la compréhension par l’utilisateur.
-: Utiliser le modèle [[Modèle:ExempleFonction|ExempleFonction]] pour compléter ce paramètre.
+: Utiliser le modèle [[modèle:fonction exemple|fonction exemple]] pour compléter ce paramètre.
+{{doc/fin | en = function }}
-{{Doc/fin}}[[Catégorie:Modèles à vérifier‎]]
+{{révision | 207737 }}