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

Question

考虑以下C#代码:

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

在构建项目时,由于无法识别的单词"ContentProperty",会发出" CA2204:文字拼写正确 "的警告.

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

代码分析是否有办法告诉单词/单词组不是要进行拼写检查,比如用引号或其他东西包围？或者只是禁用警告？

Answer 1

在 Visual Studio 2017 ^†中，我证明了可以通过使用C# 版本 6 的以下附加内容来避免代码分析警告CA2204: Literals should be拼写正确：

• $ - 字符串插值，和
• 运算符名称。

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

您还可以找到我对Visual Studio 2015 中的字符串插值和 IFormatProvider (CA1305)的回答，以避免CA1305：指定 IFormatProvider会有所帮助。

† 请注意，C# 版本 6 是随 Visual Studio 2013 一起提供的。为了避免此警告，可能还需要较新版本的 Visual Studio（带有较新版本的代码分析）。