Show Menu
SUJETS×

Conventions de style pour le code et les éléments de texte

Ces éléments identifient les options de code et les variables utilisées dans la documentation d’aide. En règle générale, vous n’incluez pas ces symboles ou éléments de style dans vos fichiers de code ou de données. Ce ne sont que des indicateurs visuels.
Convention Description
variable
Les variables apparaissent en italique . Remplacez la valeur appropriée pour le nom de la variable.
Pour plus de clarté visuelle, il arrive que des variables et d’autres éléments de code apparaissent entre < > crochets. Vous n’avez pas besoin d’utiliser ces symboles dans votre code.
[facultatif]
Les éléments placés entre crochets sont facultatifs.
(this|that)
Les éléments entre parenthèses indiquent un choix booléen OU .
littéral
Insérez du texte ou du code exactement comme indiqué.
< >
Il arrive que des variables et d’autres éléments de code apparaissent entre < > crochets. Elles sont utilisées pour améliorer la clarté dans les longs blocs de code. Sauf indication contraire, n’incluez pas ces symboles dans le nom ou le contenu d’un fichier de données.