En savoir plus sur le Vérificateur orthographique

La plupart des fonctionnalités de Visual Studio sont conçues pour vous aider à écrire le code de votre choix, aussi bien pour garantir sa compilation que pour améliorer son style. Aujourd’hui, avec la fonctionnalité Vérificateur orthographique (introduite dans la version 17.5), Visual Studio peut même vérifier l’orthographe de votre code.

Le Vérificateur orthographique est disponible pour tout fichier C#, C++ ou Markdown. Quand le Vérificateur orthographique est activé, Visual Studio marque tous les mots qu’il détecte étant mal orthographiés. Visual Studio suggère également d’autres orthographes et aide à la correction. La fonctionnalité effectue même un renommage contextuel quand ces fautes d’orthographe sont des identificateurs, pour que votre code puisse se compiler.

Vous pouvez désactiver ou activer le vérificateur orthographique en utilisant le bouton Activer/désactiver le vérificateur orthographique dans la barre d’outils principale, ou en sélectionnant la commande Modifier>Avancé>Activer/désactiver le vérificateur orthographique dans la barre de menus.

Comment l’utiliser ?

Quand le caret se trouve sur une faute d’orthographe, les Actions rapides fournissent des solutions pour corriger les fautes d’orthographe. Vous pouvez afficher les Actions rapides avec les raccourcis clavier Ctrl+. ou Alt+Entrée. Quand le menu contextuel apparaît, Visual Studio propose trois options pour gérer un problème d’orthographe.

Si l’un des dictionnaires fournit des suggestions d’orthographe, Visual Studio les affiche. Si plusieurs dictionnaires fournissent des suggestions, Visual Studio regroupe les suggestions par dictionnaire. Pour les chaînes et les commentaires, quand vous choisissez une de ces suggestions, un seul remplacement se produit sur place. Pour les identificateurs dans un document C++ ou C#, l’acceptation d’une suggestion entraîne une refactorisation/un renommage qui met à jour toutes les instances de l’identificateur afin de garantir la compilation du code.

Vous pouvez également choisir d’ignorer le problème d’orthographe. Dans ce cas, Visual Studio crée un fichier exclusion.dic dans votre répertoire AppData sur votre machine locale. Quand vous choisissez d’ignorer un mot, le vérificateur d’orthographe l’ignore dans toutes les instances de Visual Studio.

Comment cela fonctionne-t-il ?

Comme C#, C++ et Markdown utilisent tous l’anglais pour leurs mots clés, Visual Studio utilise généralement le dictionnaire « Anglais (États-Unis) » ou « en-us » pour la vérification orthographique. Visual Studio vérifie la langue d’affichage utilisée par l’instance de Windows et, si ce n’est pas « en-us », utilise également le dictionnaire correspondant.

Remarque

C# et C++ disposent également de dictionnaires supplémentaires pour les mots clés de ces langages, ce qui empêche que des mots comme « namespace » ou « alloc » soient marqués comme étant mal orthographiés.

Les commentaires des premiers utilisateurs de cette fonctionnalité nous ont informé que les développeurs veulent uniquement connaître les erreurs dans le document avec lequel ils travaillent actuellement. En réponse à ce commentaire, le vérificateur orthographique analyse uniquement les documents actifs dans l’éditeur.

Le tableau suivant montre certaines recherches que le vérificateur orthographique effectue quand il analyse un document de code :

Ce que contient le code	Ce que vérifie Visual Studio	Pourquoi ?
Hello	Hello, hello	Vérifie toujours les noms propres et communs
HelloWorld	Hello, hello, World, world	Les majuscules médiales sont utilisées pour délimiter les mots
Hello.World	Hello, hello, World, world	La ponctuation est utilisée pour délimiter les mots
_Hello123	Hello, hello	Les numéros de début ou de fin ou les marques de ponctuation sont supprimés
Hello2World	Hello, hello, World, world	Les chiffres médiaux, comme les marques de ponctuation, sont utilisés pour délimiter les mots
btnWorld	World, world	Les fragments de trois caractères ou moins sont ignorés
helloworld	Helloworld, helloworld	Aucun indicateur pour identifier les limites des mots

Si Visual Studio identifie une correspondance pour le jeton dans l’un des dictionnaires qu’il utilise, le jeton est considéré comme acceptable et l’analyse continue. Dans le cas contraire, le jeton est considéré comme étant mal orthographié et Visual Studio le marque comme une faute d’orthographe.

Guide pratique pour personnaliser le Vérificateur orthographique

Vous pouvez personnaliser le vérificateur orthographique afin qu’il soit optimisé pour un environnement collaboratif. Pour ce faire, Visual Studio utilise un fichier EditorConfig pour la configuration afin de pouvoir contrôler le comportement du vérificateur orthographique dans un dépôt.

En configurant un fichier EditorConfig, vous pouvez établir les standard de codage que vous voulez que tout le monde suive, ce qui vous permet de maintenir une cohérence de codage, difficile à obtenir par d’autres moyens.

Important

Les options d’erreur d’orthographe sont spécifiques aux fichiers. Vous devez spécifier les options d’orthographe des fichiers auxquelles elles sont appliquées. Dans l’exemple suivant, les options d’orthographe sont appliquées à tous les fichiers C# de la solution :

[*.cs]

Voici quelques exemples et scénarios de cas d’usage des commutateurs que vous pouvez configurer dans un fichier EditorConfig :

• Listez les langues que Visual Studio doit utiliser. Dans cet exemple, Visual Studio utilise uniquement les dictionnaires « en-us » et « fr-fr » pendant la vérification d’orthographe.

  spelling_languages = _language_[,_language_]
(Example: = en-us,fr-fr)

  Notes

  Veillez à installer le module linguistique des autres langues que celle que vous utilisez afin d’empêcher Visual Studio de marquer les mots de manière inappropriée comme des erreurs d’orthographe.

• Contrôlez ce que Visual Studio doit vérifier. Dans cet exemple, Visual Studio recherche les mots mal orthographiés dans les identificateurs et les commentaires, mais pas à l’intérieur des chaînes.

  spelling_checkable_types = strings,identifiers,comments
(Example: = identifiers,comments)

• Contrôlez la gravité attribuée par Visual Studio aux erreurs d’orthographe dans la liste d’erreurs. Dans cet exemple, les erreurs d’orthographe sont affichées comme des erreurs.

  spelling_error_severity = error OR warning OR information OR hint
(Example: = error)

• Créez votre propre dictionnaire d’exclusion pour spécifier les mots que vous considérez comme bien orthographiés. Dans cet exemple, la première fois que le vérificateur orthographique s’exécute sur n’importe quel fichier de la solution, Visual Studio recherche un fichier exclusion.dic. Visual Studio vérifie le même répertoire du fichier .sln pour un projet C# ou dans le répertoire racine d’un répertoire C++. S’il n’existe aucun fichier exclusion.dic, Visual Studio en crée un. Ensuite, chaque fois que l’utilisateur choisit d’ignorer un mot, Visual Studio l’ajoute à ce fichier exclusion.dic. Visual Studio considère les mots qui apparaissent dans ce fichier exclusion.dic comme des mot bien orthographiés.

  spelling_exclusion_path = absolute OR relative path to exclusion dictionary
(Example: = .\exclusion.dic)

  Notes

  Visual Studio utilise le dictionnaire d’exclusion spécifié par le commutateur spelling_exclusion_path dans votre fichier .editorconfig ou dans un fichier exclusion.dic placé dans votre répertoire %localappdata%\Microsoft\VisualStudio\<Version> si un commutateur est introuvable.

• Déterminez si le dictionnaire d’exclusion spécifique à la langue par défaut est utilisé. Cet indicateur est défini sur true par défaut. Tous les mots ajoutés au dictionnaire d’exclusion spécifique à la langue sont considérés comme correctement orthographiés. Définissez la valeur false pour ignorer les dictionnaires d’exclusion spécifiques à C++ ou C#.

  spelling_use_default_exclusion_dictionary = true OR false
(Example: = spelling_use_default_exclusion_dictionary = false)

Voici un exemple complet :

[*.{cs,vb}]                                         //specify which files the spelling options apply to
spelling_languages = en-us,fr-fr                    //specifies the en-us and fr-fr dictionaries for use in spell checking
spelling_checkable_types = identifiers,comments     //specifies that identifiers and comments are the only checked elements
spelling_error_severity = error                     //sets severity assigned to spelling errors to error in the error list
spelling_exclusion_path = exclusion.dic             //defines a custom exclusion dictionary location and file
spelling_use_default_exclusion_dictionary = false   //ignores the language-specific default exclusion dictionary

Gestion des cas particuliers

Visual Studio a des comportements uniques lors de la vérification du code pour les erreurs d’orthographe qui diffèrent de celles d’un vérificateur d’orthographe traditionnel conçu pour le texte écrit. Voici certains de ces comportements :

• Dans une chaîne qui inclut la ponctuation, par exemple« misc ». Visual Studio ne suggère pas de correction, car la ponctuation dans un identificateur peut entraîner un code qui ne se compile pas.
• Les barres obliques inverses dans une chaîne omettent la vérification orthographique du caractère suivant et traitent la barre oblique inverse et le caractère suivant comme un délimiteur de mots. Dans la chaîne hello\nworld par exemple, Visual Studio détecte d’abord la barre oblique inverse. Visual Studio traite le \n comme un délimiteur de mots. Il reste « hello » et « world » qui sont vérifiés individuellement.
• Les chaînes qui contiennent des URL comme https://... ou mailto:.. ne sont pas vérifiées sur l’ensemble de la chaîne.

Contenu connexe

• Amélioration du vérificateur orthographique