Instructions de mise en forme du texte

2025-05-03

L’utilisation cohérente et appropriée du style gras, italique et code pour les éléments de texte améliore la lisibilité et permet d’éviter les confusions. Si un élément de mise en forme de texte n’est pas couvert par cette aide, reportez-vous au Guide de style d’écriture Microsoft. Les articles suivants fournissent des conseils détaillés sur la mise en forme du texte :

Éléments d’IU

Les éléments d’interface utilisateur, tels que les éléments de menu, les noms de boîte de dialogue et les noms des zones de texte, doivent être en gras.

Ceci : dans l’Explorateur de solutions, cliquez avec le bouton droit sur le nœud du projet, puis sélectionnez Ajouter>un nouvel élément.
N’appliquez pas : Dans l’Explorateur de solutions, cliquez avec le bouton droit sur le nœud du projet et sélectionnez Ajouter > Nouvel élément.

Référentiel Git et noms de branche

Utilisez du texte gras pour le dépôt Git ou les noms de branche lorsqu’ils sont sélectionnés ou entrés dans des instructions.

Ceci : dans le menu branche, sélectionnez principal.
Pas ceci : Dans le menu des branches, sélectionnez « main ».

Introductions aux nouveaux termes

Utilisez du texte italique pour introduire un nouveau terme avec une définition ou une explication. Italiquez le nouveau terme la première fois que vous l’utilisez, puis utilisez du texte normal pour la définition ou l’explication.

Appliquez : Dans App Service, une application s’exécute dans un plan App Service. Un plan App Service définit un ensemble de ressources de calcul nécessaires à l’exécution d’une application web.
N’appliquez pas : dans App service, une application s’exécute dans un « plan App Service ». Un plan App Service définit un ensemble de ressources de calcul sur lequel une application web s’exécute.

Style code

Utiliser le style code pour :

Les éléments de code, comme les noms de méthode, les noms de propriétés et les mots clés du langage.
Commandes SQL
Les noms de package NuGet
Commandes en ligne de commande*
Les noms de table et de colonne des bases de données
Noms de ressources qui ne doivent pas être localisés (tels que les noms de machine virtuelle)
Les URL que vous ne souhaitez pas cliquables

Pourquoi ? Certains repères de style spécifient en gras pour la plupart de ces éléments de texte. Toutefois, la plupart des articles sont localisés et le style code indique au traducteur de conserver cette partie du texte non traduite.

Le style de code peut apparaître inline (entouré de `) ou dans des blocs de code délimités (entouré de ```) englobant plusieurs lignes. Placez les extraits de code et les chemins plus longs dans des blocs de code délimités.

* Dans les commandes en ligne de commande, utilisez des barres obliques dans les chemins de fichiers si elles sont prises en charge sur toutes les plateformes. Recourez à des barres obliques inverses pour illustrer les commandes qui s’exécutent sur Windows, lorsque seules les barres obliques inverses sont acceptées. Par exemple, les barres obliques fonctionnent dans l’interface CLI .NET sur toutes les plateformes. Privilégiez donc dotnet build foldername/filename.csproj plutôt que dotnet build foldername\filename.csproj.

Exemples utilisant des styles intralignes

Appliquez : Par défaut, Entity Framework interprète une propriété nommée Id ou ClassnameID comme la clé primaire.
N’appliquez pas : Par défaut, Entity Framework interprète une propriété nommée Id ou ClassnameID comme la clé primaire.
Appliquez : Le package Microsoft.EntityFrameworkCore prend en charge l’exécution d’EF Core.
N’appliquez pas : Le package Microsoft.EntityFrameworkCore prend en charge l’exécution d’EF Core.

Exemples de blocs de code délimités

Appliquez : Aucune commande n’est envoyée à la base de données par des instructions qui changent juste IQueryable, comme le code suivant :
```
    ```csharp
    var students = context.Students.Where(s => s.LastName == "Davolio")
    ```
```
N’appliquez pas : Aucune commande n’est envoyée à la base de données par des instructions qui changent juste IQueryable, comme var students = context.Students.Where(s => s.LastName == "Davolio").
Appliquez : Par exemple, pour exécuter le script Get-ServiceLog.ps1 dans le répertoire C:\Scripts, tapez :
```
    ```powershell
    C:\Scripts\Get-ServiceLog.ps1
    ```
```
N’appliquez pas : Par exemple, pour exécuter le script Get-ServiceLog.ps1 dans le répertoire C:\Scripts, tapez : "C:\Scripts\Get-ServiceLog.ps1."
Tous les blocs de code délimités doivent avoir une balise de langue approuvée. Pour obtenir la liste des balises de langue de prise en charge, consultez Inclure du code dans la documentation.

Espaces réservés

Dans le texte du paragraphe ou les étapes procédurales, utilisez italique pour le texte d’espace réservé que les utilisateurs remplaceront par leurs propres informations.

Ceci : entrez le mot de passe
Not this : Entrez « password »
Ceci : entrez -ppassword
Pas cela: Saisissez le mot de passe -p

Si vous souhaitez que l’utilisateur remplace une partie d’une chaîne d’entrée par ses propres valeurs, utilisez un texte de l’espace réservé marqué par des crochets pointus (inférieur à < et supérieur à > caractères).

Option 1 : utilisez un style de code pour entourer le mot de l’espace réservé ou la phrase englobante. Par exemple, vous pouvez utiliser des accents graves uniques ` pour la mise en forme du code inline pour une seule expression, ou trois accents graves ``` pour la mise en forme du code délimité.

`az group delete -n <ResourceGroupName>`

Rendu comme suit :

az group delete -n <ResourceGroupName>

Option 2 : utilisez une barre oblique inverse \ pour placer les caractères d’échappement entre crochets pointus dans Markdown, par exemple \< et \>. Alors que seule la première séquence d’échappement sur le crochet pointu \< est requise, l’échappement du crochet fermant \> fonctionne également pour des besoins de cohérence. Le code HTML rendu n’affiche pas le caractère d’échappement au lecteur :

az group delete -n \<ResourceGroupName\>

Rendu comme suit :

az group delete -n <ResourceGroupName>

Informez le lecteur sur l’espace réservé : dans le texte qui précède des exemples d’espace réservé, expliquez au lecteur que le texte entre crochets doit être supprimé et remplacé par des valeurs réelles. Nous vous recommandons d’utiliser l’italique pour les entrées utilisateur. Vous pouvez mettre en forme les caractères en italique dans le code inline entre crochets pointus :

Dans l’exemple suivant, remplacez le texte de l’espace réservé <ResourceGroupName> par le nom de votre propre groupe de ressources.

Attention

Le site Microsoft Learn ne restitue pas de texte d’<espace réservé> qui utilise des crochets pointus dans les cas où les crochets ne sont pas correctement placés dans une séquence d’échappement ou lorsque le texte n’est pas mis en forme par du code. Le processus de génération Microsoft Learn interprète la phrase d’<espace réservé> comme une balise HTML qui peut être dangereuse pour le navigateur du lecteur et l’indique comme une balise HTML interdite (disallowed-html-tag). Vous verrez une suggestion dans le rapport de génération, et le mot de l’espace réservé n’est pas affiché dans la sortie de la page Microsoft Learn lorsque cela se produit.

Pour éviter la perte de contenu sur les espaces réservés, utilisez des caractères de mise en forme code ou d’échappement (\<\>) comme décrit précédemment.

Nous déconseillons d’utiliser des accolades {} comme espaces réservés syntaxiques. Les lecteurs peuvent confondre des espaces réservés d’accolades avec la même notation utilisée dans :

Texte remplaçable
Chaînes de format
Interpolation de chaîne
Modèles de texte
Constructions de programmation similaires

Casse et espacement : vous pouvez séparer les noms d’espaces réservés par des traits d’union (casse « kebab ») ou par des traits de soulignement, ou vous pouvez le faire à l’aide de la casse Pascal. La casse kebab peut générer des erreurs de syntaxe et les traits de soulignement peuvent être en conflit avec le soulignement. L’utilisation de toutes les majuscules peut entrer en conflit avec des constantes nommées dans de nombreuses langues, mais elle peut également attirer l’attention sur le nom de l’espace réservé.

<Resource-Group-Name> ou <ResourceGroupName>

En-têtes

N'appliquez pas des styles tels que italique, gras ou style de code en ligne aux en-têtes.

Pourquoi ? Les titres ont leurs propres styles, car le mélange avec d'autres styles crée des incohérences.

Ceci : importer le package Microsoft.NET.Sdk.Functions
Ce n’est pas le cas : importer le package Microsoft.NET.Sdk.Functions

Texte du lien

N’appliquez pas de style inline comme italique ou gras pour lier du texte.

Pourquoi ? Les personnes se fient au texte de lien hypertexte standard pour identifier les éléments de texte comme des liens cliquables. Le style d’un lien en italique, par exemple, peut masquer le fait que le texte est un lien.

Ceci : le package NuGet Microsoft.NET.Sdk.Functions génère le fichier function.json.

Ce n’est pas le cas : le package NuGet Microsoft.NET.Sdk.Functions génère le fichier function.json.

Touches et raccourcis clavier

Quand vous faites référence à des touches ou à des combinaisons de touches, respectez les conventions suivantes :

Mettez en majuscule la première lettre des noms de touches.
Entourez les noms des touches des balises HTML <kbd> et </kbd>.
Utilisez « + » pour combiner les touches que l’utilisateur sélectionne simultanément.

Exemples de raccourcis clavier

Appliquez : sélectionnez Alt+Ctrl+S.
N'appliquez pas : Appuyez sur Alt+Ctrl+S.
N’appliquez pas : choisissez ALT+CTRL+S.

Exceptions

Des instructions de style cohérentes créent une expérience client fiable et simplifient le processus de création. Les exceptions à ces recommandations doivent être prises en compte avec soin.

Si l’exception implique l’utilisation d’un autre style de texte qui appelle normalement du code, assurez-vous qu’il est ok de traduire le texte dans les versions localisées de l’article. Pour les scénarios où vous souhaitez empêcher la localisation sans utiliser le style code, consultez Chaînes non localisées.