Kit de développement logiciel (SDK) de la plateforme du compilateur .NET

2025-06-22

Les compilateurs créent un modèle détaillé de code d’application, car ils valident la syntaxe et la sémantique de ce code. Ils utilisent ce modèle pour générer la sortie exécutable à partir du code source. Le Kit de développement logiciel (SDK) de la plateforme du compilateur .NET fournit l’accès à ce modèle. De plus en plus, nous nous appuyons sur des fonctionnalités d’environnement de développement intégré (IDE), telles que IntelliSense, la refactorisation, le renommage intelligent, « Rechercher toutes les références » et « Accéder à la définition » pour augmenter notre productivité. Nous nous appuyons sur des outils d’analyse du code pour améliorer notre qualité du code et les générateurs de code pour faciliter la construction d’applications. À mesure que ces outils sont plus intelligents, ils ont besoin d’accéder à plus de modèles que seuls les compilateurs créent au fur et à mesure qu’ils traitent le code d’application. Il s’agit de la mission principale des API Roslyn : ouvrir les boîtes opaques et permettre aux utilisateurs finaux de partager dans la richesse des compilateurs d’informations sur notre code. Au lieu d’être opaque source-code-in et object-code-out translators, via Roslyn, les compilateurs deviennent des plateformes : API que vous pouvez utiliser pour les tâches liées au code dans vos outils et applications.

Concepts du Kit de développement logiciel (SDK) de la plateforme du compilateur .NET

Le Kit de développement logiciel (SDK) de la plateforme du compilateur .NET réduit considérablement la barrière à l’entrée pour la création d’outils et d’applications axés sur le code. Il crée de nombreuses opportunités d’innovation dans des domaines tels que la méta-programmation, la génération de code et la transformation, l’utilisation interactive des langages C# et Visual Basic et l’incorporation de C# et Visual Basic dans des langages spécifiques au domaine.

Le Kit de développement logiciel (SDK) de la plateforme du compilateur .NET vous permet de générer des analyseurs et des correctifs de code qui recherchent et corrigent les erreurs de codage. Les analyseurs comprennent la syntaxe (structure de code) et la sémantique pour détecter les pratiques qui doivent être corrigées. Les correctifs de code fournissent un ou plusieurs correctifs suggérés pour résoudre les erreurs de codage détectées par les analyseurs ou les diagnostics du compilateur. En règle générale, un analyseur et les correctifs de code associés sont empaquetés ensemble dans un seul projet.

Les analyseurs et les correctifs de code utilisent l’analyse statique pour comprendre le code. Ils n’exécutent pas le code ni ne fournissent d’autres avantages de test. Toutefois, elles peuvent signaler des pratiques qui mènent souvent à des bogues, à un code non durable ou à une violation des directives standard.

Outre les analyseurs et les correctifs de code, le Kit de développement logiciel (SDK) de la plateforme du compilateur .NET vous permet également de créer des refactorisations de code. Il fournit également un ensemble unique d’API qui vous permettent d’examiner et de comprendre une base de code C# ou Visual Basic. Étant donné que vous pouvez utiliser cette base de code unique, vous pouvez écrire des analyseurs et des correctifs de code plus facilement en tirant parti des API d’analyse syntaxique et sémantique fournies par le Kit de développement logiciel (SDK) de la plateforme du compilateur .NET. Libéré de la grande tâche de réplication de l’analyse effectuée par le compilateur, vous pouvez vous concentrer sur la tâche la plus axée sur la recherche et la résolution des erreurs de codage courantes pour votre projet ou bibliothèque.

Un avantage plus petit est que vos analyseurs et correctifs de code sont plus petits et utilisent beaucoup moins de mémoire quand ils sont chargés dans Visual Studio que si vous avez écrit votre propre codebase pour comprendre le code dans un projet. En tirant parti des mêmes classes utilisées par le compilateur et Visual Studio, vous pouvez créer vos propres outils d’analyse statique. Cela signifie que votre équipe peut utiliser des analyseurs et des correctifs de code sans impact notable sur les performances de l’IDE.

Il existe trois scénarios principaux pour l’écriture d’analyseurs et de correctifs de code :

Appliquer des normes de codage d’équipe
Fournir des conseils sur les packages de bibliothèque
Fournir des conseils généraux

Appliquer des normes de codage d’équipe

De nombreuses équipes ont des normes de codage appliquées via des révisions de code avec d’autres membres de l’équipe. Les analyseurs et les correctifs de code peuvent rendre ce processus beaucoup plus efficace. Les révisions de code se produisent lorsqu’un développeur partage son travail avec d’autres personnes de l’équipe. Le développeur aura investi tout le temps nécessaire pour terminer une nouvelle fonctionnalité avant d’obtenir des commentaires. Les semaines peuvent passer pendant que le développeur renforce les habitudes qui ne correspondent pas aux pratiques de l’équipe.

Les analyseurs s’exécutent en tant que développeur écrit du code. Le développeur reçoit immédiatement des commentaires qui encouragent à suivre immédiatement les instructions. Le développeur crée des habitudes pour écrire du code conforme dès qu’il commence le prototypage. Lorsque la fonctionnalité est prête à être examinée par les humains, toutes les recommandations standard ont été appliquées.

Teams peut créer des analyseurs et des correctifs de code qui recherchent les pratiques les plus courantes qui violent les pratiques de codage d’équipe. Celles-ci peuvent être installées sur l’ordinateur de chaque développeur pour appliquer les normes.

Conseil / Astuce

Avant de créer votre propre analyseur, consultez les composants intégrés. Pour plus d’informations, consultez règles de style code.

Fournir des conseils sur les packages de bibliothèque

Il existe une multitude de bibliothèques disponibles pour les développeurs .NET sur NuGet. Certains d’entre eux proviennent de Microsoft, d’autres d’entreprises tierces, et d’autres de membres de la communauté et de bénévoles. Ces bibliothèques obtiennent plus d’adoption et des révisions plus élevées lorsque les développeurs peuvent réussir avec ces bibliothèques.

En plus de fournir de la documentation, vous pouvez fournir des analyseurs et des correctifs de code qui recherchent et corrigent les mauvaises utilisations courantes de votre bibliothèque. Ces corrections immédiates aideront les développeurs à réussir plus rapidement.

Vous pouvez empaqueter des analyseurs et des correctifs de code avec votre bibliothèque sur NuGet. Dans ce scénario, chaque développeur qui installe votre package NuGet installe également le package d’analyseur. Tous les développeurs qui utilisent votre bibliothèque recevront immédiatement des conseils de votre équipe sous la forme de commentaires immédiats sur les erreurs et les corrections suggérées.

Fournir des conseils généraux

La communauté des développeurs .NET a découvert, par le biais de l’expérience, des modèles qui fonctionnent bien et des modèles qui sont mieux évités. Plusieurs membres de la communauté ont créé des analyseurs qui appliquent ces modèles recommandés. À mesure que nous en apprenons davantage, il y a toujours de la place pour de nouvelles idées.

Ces analyseurs peuvent être chargés sur Visual Studio Marketplace et téléchargés par les développeurs à l’aide de Visual Studio. Les nouveaux arrivants dans la langue et la plateforme apprennent rapidement les pratiques acceptées et deviennent productifs plus tôt dans leur parcours .NET. À mesure qu’elles deviennent plus largement utilisées, la communauté adopte ces pratiques.

Générateurs de code source

Les générateurs sources visent à activer la métagrammation du temps de compilation, c’est-à-dire le code qui peut être créé au moment de la compilation et ajouté à la compilation. Les générateurs sources sont en mesure de lire le contenu de la compilation avant l’exécution, ainsi que d’accéder aux fichiers supplémentaires. Cette possibilité leur permet d’introspecter le code C# utilisateur et les fichiers spécifiques au générateur. Vous pouvez apprendre à créer des générateurs sources incrémentiels à l’aide du livre de recettes du générateur source.

Étapes suivantes

Le Kit de développement logiciel (SDK) .NET Compiler Platform inclut les derniers modèles objet de langage pour la génération, l’analyse et la refactorisation du code. Cette section fournit une vue d’ensemble conceptuelle du Kit de développement logiciel (SDK) de la plateforme du compilateur .NET. Vous trouverez plus d’informations dans les sections des guides de démarrage rapide, des exemples et des didacticiels.

Vous pouvez en savoir plus sur les concepts du Kit de développement logiciel (SDK) de la plateforme du compilateur .NET dans les cinq rubriques suivantes :

Pour commencer, vous devez installer le Kit de développement logiciel (SDK) de la plateforme du compilateur .NET :

Instructions d’installation - Visual Studio Installer

Il existe deux façons de trouver le Kit de développement logiciel (SDK) de la plateforme du compilateur .NET dans Visual Studio Installer :

Installer à l’aide de l’affichage Visual Studio Installer - Charges de travail

Le Kit de développement logiciel (SDK) de la plateforme du compilateur .NET n’est pas automatiquement sélectionné dans le cadre de la charge de travail de développement d’extension Visual Studio. Vous devez le sélectionner en tant que composant facultatif.

Exécuter Visual Studio Installer
Sélectionnez Modifier
Vérifiez la charge de travail de développement d’extension Visual Studio .
Ouvrez le nœud de développement d’extension Visual Studio dans l’arborescence récapitulative.
Cochez la case pour le Kit de développement logiciel (SDK) de la plateforme du compilateur .NET. Vous le trouverez en dernier sous les composants facultatifs.

Si vous le souhaitez, vous souhaiterez également que l’éditeur DGML affiche des graphiques dans le visualiseur :

Ouvrez le nœud Composants individuels dans l’arborescence récapitulative.
Cochez la case pour l’éditeur DGML

Installer à l’aide de l’onglet Visual Studio Installer - Composants individuels

Exécuter Visual Studio Installer
Sélectionnez Modifier
Sélectionnez l’onglet Composants individuels
Cochez la case pour le Kit de développement logiciel (SDK) de la plateforme du compilateur .NET. Vous le trouverez en haut sous la section Compilateurs, outils de génération et runtimes .