Modèle:Fonction/doc
Aller à la navigation
Aller à la recherche
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.