c# - 我可以使用 ReSharper 来强制执行评论标准吗？

Question

最近在 ReSharper 上玩了很多，我想为我的团队设置的一件事是如果 C# 类或 C# 文件没有设置的代码注释标准时的通知。不幸的是，我还没有找到关于这个话题的很多东西。

例如，我想确保所有方法或函数上面都有注释描述：

/// <summary>
/// Description of MyMethod here.
/// </summary>
public void MyMethod();

我还想看看（代码行数）/（注释行数）是否在一些神奇的快乐媒介周围的基本检查，如果不是，则创建通知或警告。

Answer 1

一个简单的开始选项（甚至不需要 R#）是打开 XML 文档文件的生成，然后将警告视为错误。这将确保每个公共成员都有文档。

当然，它不能确保评论是好的……但它会确保它们存在。

编辑：R#确实有一个设置 - 在代码检查、检查严重性、C#、编译器警告下，查找CS1591: Missing XML comment for publicly visible type or member（以及它附近的相关警告）。将其严重性更改为错误，它可能会对您有所帮助 - 但由于您处于不寻常的环境中，所以很难说。

Answer 2

不要与 Jon 竞争，但GhostDoc会按照您的描述进行。

Answer 3

此外，请查看具有 Resharper 插件的StyleCop，这意味着缺少注释（对于方法、属性等）将显示为 Resharper 警告/错误。您可能感兴趣，也可能不感兴趣，但至少这是一个选择。

Answer 4

有两种选择。两者都 - 使用 ReSharper 的扩展 - 而不是 Visual Studio（如果您不知道，ReSharper 有自己的扩展管理器）。这些扩展是（使用第二个！）：

1. 特工史密斯（用于 R#9）。现在，我的 ReSharper 的扩展管理器说，此扩展适用于 9.0 版的 ReSharper（我已安装），但实际上，此扩展适用于错误（禁用突出显示无法正常工作）。

2. ReSharper 9 的 XML 文档检查。似乎，没有任何问题（我刚刚安装）。这就是您真正需要突出显示没有 XML 注释的类、方法、属性等（甚至是私有字段）！

Answer 5

Stylecop有许多注释规则，您可能还想查看Stylecop+，因为它有一些关于方法/属性长度的额外规则。