Listes de paramètres
Lorsque vous documentez des interfaces et des fonctions de programmation, vous pouvez utiliser une liste de paramètres afin de décrire les paramètres d'une application et/ou d'une fonction.
Une liste de paramètres est un outil utilisé spécialement pour présenter les paramètres de l'interface de programmation d'une application ou d'un programme. La liste de paramètres (parml) possède la même structure qu'une liste de définitions (dl).
Un élément liste de paramètres (parml) contient un ou plusieurs éléments d'entrées de liste de paramètres (plentry), chaque entrée devant contenir un élément nom ou terme de paramètre (pt) et un élément description du paramètre (pd).
Voici un exemple de liste de paramètres utilisée pour décrire du code de programmation :
<codeblock>callHelp(hFilename, contentId)</codeblock>
<p>
<parml>
<plentry>
<pt>hFileName</pt>
<pd>est le chemin relatif ver le fichier Aide</pd>
</plentry>
<plentry>
<pt>contentId</pt>
<pd>est l'ID de la rubrique à afficher.</pd>
</plentry>
</parml>
</p>