程序员不看警告!
于是 C# 8.0 带来的可空引用类型由于默认以警告的形式出现,所以实际上约束力非常弱。
本文将把 C# 8.0 的可空引用类型警告提升为错误,以提高约束力。
启用可空引用类型
你需要先在你的项目中启用可空引用类型的支持,才能修改警告到错误:
项目属性
在项目属性中设置是比较快捷直观的方法。
在项目上右键属性,打开“生成”标签。
在这里,可以看到“将警告视为错误”一栏:
- 无
- 所有
- 特定警告
可以看到默认选中的是“特定警告”且值是 NU1605
。
NU 是 NuGet 中发生的错误或者警告的前缀,NU1605
是大家可能平时经常见到的一个编译错误“检测到包降级”。关于这个错误的信息可以阅读官网:NuGet Warning NU1605 - Microsoft Docs,本文不需要说明。
于是,我们将我们需要视为错误的错误代码补充到后面就可以,以分号分隔。
NU1605;CS8600;CS8602;CS8603;CS8604;CS8618;CS8625
这些值的含义可以参考我的另一篇博客:
记得在改之前,把前面的配置从“活动”改为“所有配置”,这样你就不用改完之后仅在 Debug 生效,完了还要去 Release 配置再改一遍。
WarningsAsErrors
前面使用属性面板指定时,有一个奇怪的默认值。实际上我们直接修改将固化这个默认值,这不利于将来项目跟随 Sdk 或者 NuGet 包的升级。
所以,最好我们能直接修改到项目文件,以便更精细地控制这个属性的值。
在上一节界面中设置实际上是生成了一个属性 WarningsAsErrors
。那么我们现在修改 WarningsAsErrors
属性的值,使其拼接之前的值:
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>netcoreapp3.0</TargetFramework>
<LangVersion>latest</LangVersion>
<Nullable>enable</Nullable>
++ <WarningsAsErrors>$(WarningsAsErrors);CS8600;CS8601;CS8602;CS8603;CS8604;CS8609;CS8610;CS8616;CS8618;CS8619;CS8622;CS8625</WarningsAsErrors>
</PropertyGroup>
</Project>
这句话的含义是先获取之前的值,将其放到我们要设置的值的前面。这样可以跟随 Sdk 或者 NuGet 包的升级而更新此默认值。
这些值的含义可以参考我的另一篇博客:
参考资料
本文会经常更新,请阅读原文: https://dotnet-campus.github.io//post/warning-as-errors-for-csharp-nullable-reference-types.html ,以避免陈旧错误知识的误导,同时有更好的阅读体验。
本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。欢迎转载、使用、重新发布,但务必保留文章署名 dotnet 职业技术学院 (包含链接: https://dotnet-campus.github.io/ ),不得用于商业目的,基于本文修改后的作品务必以相同的许可发布。如有任何疑问,请 与我联系 。