Conventions typographiques (Visual Basic)

  • Article

La documentation Visual Basic utilise les conventions de typographie et de code suivantes.

Conventions typographiques

Exemple Description
Sub, If, ChDir, Print, True, Debug Les mots clés spécifiques à la langue et les membres du runtime ont des lettres majuscules initiales et sont mis en forme comme indiqué dans cet exemple.
SmallProject, ButtonCollection Les mots et les expressions que vous devez taper sont mis en forme comme indiqué dans cet exemple.
Module, instruction Les liens sur lesquels vous pouvez cliquer pour accéder à une autre page d’aide sont mis en forme comme illustré dans cet exemple.
object, variableName, argumentList Les espaces réservés pour les informations que vous fournissez sont mis en forme comme indiqué dans cet exemple.
[ Shadows ], [ expressionList ] Dans la syntaxe, les éléments facultatifs sont placés entre crochets.
{ Public | Friend | Private } Dans la syntaxe, lorsque vous devez faire un choix entre deux éléments ou plus, les éléments sont placés entre accolades et séparés par des barres verticales.

Vous devez sélectionner un seul des éléments.
[ Protected | Friend ] Dans la syntaxe, lorsque vous avez la possibilité de sélectionner entre deux éléments ou plus, les éléments sont placés entre crochets et séparés par des barres verticales.

Vous pouvez sélectionner n’importe quelle combinaison d’éléments, ou aucun élément.
[{ ByVal | ByRef }] Dans la syntaxe, lorsque vous ne pouvez pas sélectionner plus d’un élément, mais que vous pouvez également omettre complètement les éléments, ils sont placés entre crochets, entourés d’accolades et séparés par des barres verticales.
memberName1, memberName2, memberName3 Plusieurs instances du même espace réservé sont différenciées par des indices, comme illustré dans l’exemple.
memberName1

...

memberNameN		 Dans la syntaxe, des points de suspension (...) sont utilisés pour indiquer un nombre indéfini d’éléments de ce type juste devant les points de suspension.

Dans le code, les points de suspension signifient le code omis par souci de clarté.
ÉCHAP, ENTRÉE Les noms de touches et les séquences de touches du clavier apparaissent dans toutes les lettres majuscules.
Alt+F1 Lorsque des signes plus (+) s’affichent entre les noms de touche, vous devez maintenir l’une des touches enfoncées tout en appuyant sur l’autre. Par exemple, ALT+F1 signifie maintenir la touche ALT enfoncée tout en appuyant sur la touche F1.

Conventions de code

Exemple Description
sampleString = "Hello, world!" Les exemples de code apparaissent dans une police à hauteur fixe et sont mis en forme comme indiqué dans cet exemple.
L’instruction précédente définit la valeur de sampleString sur « Hello, world! » Les éléments de code dans le texte explicatif s’affichent dans une police à hauteur fixe, comme illustré dans cet exemple.
' This is a comment.

REM This is also a comment.		 Les commentaires de code sont introduits par une apostrophe (') ou le mot clé REM.
sampleVar = "This is an " _

& "example" _

& " of how to continue code."		 Un espace suivi d’un trait de soulignement ( _) à la fin d’une ligne indique que l’instruction continue sur la ligne suivante.

Voir aussi