Conventions de style pour les éléments de code et de texte style-conventions-for-code-and-text-elements
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
variableLes variables apparaissent en italique. Remplacez le nom de variable par la valeur appropriée.
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.
[optional]Les éléments entre crochets sont facultatifs.
(this|that)Les éléments entre parenthèses indiquent un choix BOOLÉEN OU.
literalIncluez le texte ou le code exactement comme indiqué.
< >Parfois, des variables et d’autres éléments de code apparaissent entre < > crochets. Ils sont utilisés pour améliorer la clarté dans les blocs de code longs. Sauf indication contraire, n’incluez pas ces symboles dans le nom d’un fichier de données ou son contenu.
recommendation-more-help
de293fbf-b489-49b0-8daa-51ed303af695