在SuppressMessage属性中需要包含什么？

Question

我有一些代码违反了，比如说，CA1051

public class Logger {
    // Generates a warning "Do not declare visible instance fields".
    public Level LogLevel = Level.Warning;
}

我想压制这个警告，因为我是故意违反规则的。MSDN说使用SuppressMessage属性这样做：

[SuppressMessage("Design", "CA1051: Do not declare visible instance fields", Justification = "Clearest way of exposing this field.")]
public Level LogLevel = Level.Warning;

但所有的例子暗示：

• 我必须找到MSDN上错误的文档。
• 我得查一下这个类别。
• 我得查一下警告的全名

是否有更简单的方法来抑制错误/警告？

Answer 1

是的，有一种更简单的方法来抑制这样的错误/警告！

// Minimal required:
[SuppressMessage("", "CA1051")]
public Level LogLevel = Level.Warning;

// What I recommend
[SuppressMessage("", "CA1051", Justification = "Clearest way of exposing this field")]
public Level LogLevel = Level.Warning;

它似乎没有文档，但ID足以阻止消息。我建议添加一个Justification，因为这可以帮助代码的其他读者理解为什么您选择违反规则。

还请注意，Visual将帮助您自动生成这些抑制属性。与代码似乎不一样。