c# - CA2204 警告在字符串文字中提及类型名称

Question

考虑以下 C# 代码:

if (atr == null) throw new InvalidOperationException("No ContentProperty attribute found on type.");

在构建项目时，由于无法识别单词“ContentProperty”，会发出“ CA2204:文字应正确拼写”警告。

我知道我可以禁用规则(全局或仅用于包含方法)或创建自定义代码分析字典并将“ContentProperty”添加为可识别的词。但是，这些解决方案中没有一个对我有吸引力。在异常消息中引用类型或类成员名称在我的项目中，这是一个应用程序框架，肯定会发生很多。

代码分析是否有办法判断一个词/词组不需要进行拼写检查 ，比如用引号或其他东西包围时？或者禁用警告是解决此问题的唯一方法？

Answer 1

使用 Visual Studio 2017 †，我已经证明了代码分析警告 CA2204: Literals should be spelled correctly可以通过使用 following additions to C# version 6 避免:

$ - string interpolation , 和

nameof operator .

if (atr == null)
{
    throw new InvalidOperationException(
        $"No {nameof(ContentProperty)} attribute found on type.");
}

您还可以找到 my answer至 String Interpolation in Visual Studio 2015 and IFormatProvider (CA1305)避免 CA1305: Specify IFormatProvider乐于助人。

† 请注意，C# 版本 6 随 Visual Studio 2013 一起提供。可能还需要更新版本的 Visual Studio(带有更新版本的代码分析)以避免此警告。