Configuration des erreurs et des avertissements en C#

Compréhension des avertissements et des erreurs

Dans la vidéo, Derek présente le concept de reporting des avertissements du compilateur ou de l'analyseur Roslyn en tant qu'erreurs. Il explique qu'il s'agit d'un processus simple qui peut aider à prévenir des problèmes futurs. Par exemple, lorsqu'on travaille avec des méthodes asynchrones, oublier d'utiliser le mot-clé await peut entraîner des bogues potentiels. Derek démontre un scénario où sa méthode SaveChangesAsync déclenche un avertissement car elle n'est pas awaitée. Il insiste sur l'importance de traiter ces avertissements à temps pour éviter qu'ils ne se transforment en problèmes plus importants par la suite.

Cette approche permet d'améliorer la qualité du code, la maintenabilité et la stabilité globale du système. Qu'il s'agisse de fichiers de configuration, de gestion des exceptions ou de paramètres système, il est essentiel de comprendre comment gérer efficacement ces avertissements pour créer des applications résilientes.

Conversion des avertissements en erreurs

Pour convertir les avertissements en erreurs, Derek suggère de modifier le fichier de projet (.csproj). Il montre comment ajouter un élément <WarningsAsErrors> dans le <PropertyGroup> du fichier de projet. Plus précisément, pour l'avertissement CS4014 (généré lorsque await est manquant), ajouter cet élément convertit l'avertissement en une erreur, entraînant l'échec de la construction si le problème persiste. Cette approche permet d'appliquer des normes de codage plus strictes et de détecter les erreurs potentielles dès le début du processus de développement de l'application.

<PropertyGroup>
  <WarningsAsErrors>CS4014</WarningsAsErrors>
</PropertyGroup>

<PropertyGroup>
  <WarningsAsErrors>CS4014</WarningsAsErrors>
</PropertyGroup>

Application du concept aux analyseurs Roslyn

Derek étend cette approche aux analyseurs Roslyn, qui produisent également des avertissements. Il utilise le package Microsoft Visual Studio Threading Analyzer comme exemple.

En ajoutant ce paquet au projet et en réintroduisant le problème async, Derek met en évidence la façon dont les avertissements de l'analyseur Roslyn peuvent également être transformés en erreurs. Cette traduction est particulièrement utile pour les équipes qui s'appuient sur ces analyseurs pour faire respecter les normes et les pratiques de codage. En traitant ces avertissements comme des erreurs, les développeurs peuvent s'assurer que le code respecte les directives définies dans le cadre et éviter les problèmes potentiels en production.

<ItemGroup>
  <PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers" Version="16.10.56" />
</ItemGroup>

<PropertyGroup>
  <WarningsAsErrors>VSTHRD103</WarningsAsErrors>
</PropertyGroup>

<ItemGroup>
  <PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers" Version="16.10.56" />
</ItemGroup>

<PropertyGroup>
  <WarningsAsErrors>VSTHRD103</WarningsAsErrors>
</PropertyGroup>

Ignorer les avertissements spécifiques

Dans certains cas, certains avertissements peuvent ne pas être pertinents pour votre projet. Derek discute de la manière d'ignorer ces avertissements en utilisant l'élément <NoWarn> dans le fichier de projet. Il utilise l'exemple d'un avertissement sur la convention de nommage async (VSTHRD200), avec lequel il est en désaccord et qu'il choisit d'ignorer en l'ajoutant à <NoWarn>. Cette fonctionnalité permet aux développeurs d'adapter le système d'alerte et de signalement des erreurs à leurs besoins spécifiques, en se concentrant sur les problèmes les plus importants pour leur projet et en ignorant ceux qui ne le sont pas.

<PropertyGroup>
  <NoWarn>VSTHRD200</NoWarn>
</PropertyGroup>

<PropertyGroup>
  <NoWarn>VSTHRD200</NoWarn>
</PropertyGroup>

Configuration à l'échelle de la solution

En guise de conseil supplémentaire, Derek démontre comment appliquer ces configurations à l'échelle de la solution en utilisant un fichier Directory.Build.props. Cette approche assure que les paramètres sont cohérents à travers tous les projets au sein de la solution, ce qui permet de gagner du temps et de maintenir l'uniformité. En plaçant les configurations dans ce fichier centralisé, les équipes peuvent appliquer les mêmes valeurs et règles de normes de codage à plusieurs projets, garantissant ainsi que toutes les bases de code respectent les mêmes directives. Cela peut être particulièrement utile pour les grandes équipes ou les organisations ayant plusieurs projets en cours de développement.

<Project>
  <PropertyGroup>
    <WarningsAsErrors>CS4014;VSTHRD103</WarningsAsErrors>
    <NoWarn>VSTHRD200</NoWarn>
  </PropertyGroup>
</Project>

<Project>
  <PropertyGroup>
    <WarningsAsErrors>CS4014;VSTHRD103</WarningsAsErrors>
    <NoWarn>VSTHRD200</NoWarn>
  </PropertyGroup>
</Project>

Conclusion

En suivant les différentes étapes de configuration décrites par Derek Comartin, vous pouvez gérer efficacement les avertissements du compilateur et de l'analyseur Roslyn dans vos projets C#. La configuration des avertissements en tant qu'erreurs permet de maintenir une qualité de code élevée et d'éviter que des problèmes potentiels ne passent inaperçus. Pour une présentation plus détaillée, vous pouvez regarder la vidéo complète de Derek intitulée "Configurer les erreurs et les avertissements en C#" sur sa chaîne YouTube CodeOpinion.