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

Ces éléments identifient les options de code et les variables utilisées dans toute 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 s’affichent 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. Il n’est pas nécessaire d’utiliser ces symboles dans votre code.

[optional]

Les éléments entre crochets sont facultatifs.

(this|that)

Les éléments entre parenthèses indiquent un choix booléen OU .

literal

Insérez du texte ou du code exactement comme indiqué.

< >

Parfois, 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.

Sur cette page