问题标签 [stylecop]

我正在使用 StyleCop 并想抑制一些不适合我风格的警告。我更喜欢有解决方案

1) 内联代码抑制
2) 全局设置抑制

我已经搜索了互联网，但仍然不确定如何进行压制。

对于方法1），他们说要添加以下行：

[程序集：SuppressMessage("Microsoft.Design", "SA1202:所有私有方法必须放在所有公共方法之后", Scope = "namespace", Target = "Consus.Client.ClientVaultModule.Services.OnlineDetection")]

但他们没有说在哪里以及使用哪个命名空间。

对于方法 2），他们说要使用 GlobalSuppress 文件，但目前似乎并不容易搜索操作方法。

请帮忙。

[编辑]就我而言，我有关于SA1202 的警告：所有私有方法必须放在所有令人困扰的公共方法之后，因为我将相关代码分组到区域中。我想仅针对某些特定方法抑制这些警告。

可能重复：
如何抑制 StyleCop 警告？

我正在编写一组混合私有/公共的方法，需要放入同一区域（使用#region）。我使用了此处提到的方法，但无法抑制此警告。请帮忙。

[编辑] 我只需要抑制这个特定的警告——而不是整个项目/解决方案。但我愿意知道如何做到这一点^_^

下面的代码在我写的时候看起来不错，但是当我再次回到它时，很难理解发生了什么。曾经有括号value == ...，但在 StyleCop 成为强制性后我不得不删除它们（我无法真正控制这一点）。那么，如何改进这部分代码呢？我在想：x = value == y ? true : false;，但这可能更令人困惑，而且很愚蠢，尽管编译器会优化它。

是否有可能让 StyleCop 说这是使用花括号的正确方法？

但不是这个

或这个：

我也希望这种行为适用于 if、else、else if、while、foreach 和 for。但不适用于类声明或方法声明。

我想SuppressMessageAttribute在一些代码中添加一个 StyleCop，但我不想要求安装 StyleCop。

我的项目是否需要引用 StyleCop 二进制文件，如果需要，是哪些？另外，StyleCopSuppressMessageAttribute与System.Diagnostics.CodeAnalysis.SuppressMessageAttribute?

如何使用 Style-cop .Net 代码解析特定的 .Cs 文件？

有时需要冗长的评论。当有一个需要长时间解释的 fugly hack 时，就会发生这种情况。是的，最好完全避免/修复黑客攻击，但通常会有时间压力，必须将其推迟到未来。如果是这样的话，那么有一个详细的评论是非常有帮助的，包括那些将用更好的代码替换 hack 的人。关键是要确保他们确切地了解黑客正在做什么以及为什么。

这通常需要多个段落。如果允许这样的空白评论，评论将更具可读性//。但是，StyleCop不喜欢那些，我们总体上同意它，所以我们尝试坚持它的所有建议。现在，我可以想到三个选项：

（我不喜欢第一个，因为我通常使用双/三/四注释来注释掉代码段）。

（我不喜欢第二种选择；我认为它看起来有点愚蠢）

（我也不喜欢第三种选择。它非常适合///方法文档，但在这里它看起来有点不合时宜。

请提出更好的方法。

我知道，StyleCop它并不完美，但我们尝试以一种有用的方式使用它。我确实喜欢它抱怨无证争论的事实。现在，对于属性和构造函数，它建议文本应该是什么，但它对方法没有帮助Dispose，我认为它应该。我们有许多实现IDisposable. 在这种特殊情况下，该类是一个WinForm. 问题是我还没有为这个Dispose方法提供很好的文档，我也没有在网上看到一个很好的例子。许多例子没有任何评论。我希望觉得Dispose方法对他们来说是第二天性的人，可以帮助我一劳永逸地记录这一点，以便我可以在任何地方重复使用此评论。

这是我们所拥有的：

这是警告信息：

我希望其他 So 用户也能找到这个有用的答案。如果您有任何问题，请告诉我。

我们的团队有一些我想通过 stylecop 规则强制执行的代码指南。对于大多数事情，使用 Settings.Stylecop 文件。但是，我想强制执行私有方法的文档，但在设置文件中找不到执行此操作的方法。如果我右键单击一个项目并选择“stylecop settings”，我可以取消选中“Documentation Rules”下的“Ignore privates”，这将实现我的目标，但我无法弄清楚如何在解决方案方面和大多数情况下强制执行此规则重要的是，此设置不会保存到 Settings.Stylecop 文件中。

所以，这两个问题是：

1. 如何在解决方案的基础上强制执行私有方法的文档，以便与团队共享？
2. 项目设置（覆盖设置文件的设置）存储在哪里？

有时可能会混淆阅读引用同一类（或基类）的其他实例成员的实例成员中的代码：

拥有类似“用“_”作为所有私有/受保护成员前缀的编码标准并没有帮助，因为实例成员仍然可以引用公共成员。

阅读此内容会更好：

有没有办法通过编译器选项、StyleCop 或类似的东西来强制执行此操作？