C# 常见问题

在 C# 中配置错误和警告

Derek Comartin

8m 28s

在 C# 中配置错误和警告是维护健壮可靠代码的一个重要方面。在 C# 中，编译器和 Roslyn 分析器会提供警告，提醒开发人员注意代码中的潜在问题。通过将这些警告配置为错误处理，开发人员可以执行更严格的编码标准，确保小问题在升级为更大问题之前得到解决。

Derek Comartin 在他的 CodeOpinion YouTube 频道上就如何将这些警告配置为错误处理，从而执行更严格的编码标准提供了宝贵的见解。本文受 Derek 的视频"Configuring Errors and Warnings in C#"启发，提供了实施这些实践的综合指南，以确保更稳健的开发流程。

了解警告和错误

在视频中，Derek 介绍了将编译器或 Roslyn 分析器警告作为错误报告的概念。他解释说，这是一个简单明了的过程，有助于防止今后出现问题。例如，在使用异步方法时，忘记使用 await 关键字可能会导致潜在的错误。 Derek演示了一个场景，其中他的SaveChangesAsync方法触发了一个警告，因为它没有被await。他强调了及早解决此类警告的重要性，以确保它们不会演变成更大的问题。

这种方法有助于提高代码质量、可维护性和整个系统的稳定性。无论是处理配置文件、异常处理还是系统设置，了解如何有效管理这些警告是构建弹性应用程序的关键。

将警告转换为错误

要将警告转换为错误，Derek 建议修改项目文件（.csproj）。他展示了如何在项目文件的<WarningsAsErrors>元素。具体来说，对于警告CS4014（当缺少await时生成的），添加这个元素将警告转换为错误，如果问题持续存在，构建将失败。这种方法执行了更严格的编码标准，有助于在应用程序开发过程中尽早发现潜在错误。

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

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

XML

将概念应用于 Roslyn 分析器

Derek 将这种方法扩展到 Roslyn 分析器，它也会产生警告。他以 Microsoft Visual Studio Threading Analyzer 软件包为例。

显示警告/错误配置示例的截图。

通过将该软件包添加到项目中并重新引入 async 问题，Derek 强调了 Roslyn 分析器的警告如何也会变成错误。这对于依赖这些分析器来执行编码标准和实践的团队尤其有用。通过将这些警告视为错误，开发人员可以确保代码符合框架定义的准则，避免在生产中出现潜在问题。

<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>

XML

忽略特定警告

在某些情况下，某些警告可能与您的项目无关。 Derek讨论了如何使用项目文件中的<NoWarn>中来忽略它。这一功能允许开发人员根据自己的具体需求定制警告和错误报告系统，将重点放在对其项目最重要的问题上，而忽略那些不重要的问题。

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

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

XML

解决方案范围内的配置

作为额外提示，Derek演示了如何使用Directory.Build.props文件在整个解决方案中应用这些配置。这种方法确保了设置在解决方案中的所有项目中保持一致，从而节省时间并保持统一性。通过将配置放在这个集中式文件中，团队可以在多个项目中执行相同的编码标准值和规则，确保所有代码库都遵守相同的准则。这对于有多个项目正在开发的大型团队或组织尤其有用。

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

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

XML

结论

按照 Derek Comartin 概述的各种配置步骤，您可以有效管理 C# 项目中的编译器和 Roslyn 分析器警告。将警告配置为错误有助于保持代码的高质量，防止潜在问题漏掉。如需更详细的演示，您可以在他的 CodeOpinion YouTube 频道上观看 Derek 题为 "在 C# 中配置错误和警告 "的完整视频。