我可以使用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有自己的Extension Manager）。这些扩展名是（使用第二个扩展名）：

1. AgentSmith（针对R＃9）。现在，我的ReSharper的扩展管理器说，这个扩展是针对版本9.0的ReSharper（我已经安装），但实际上，这个扩展可以解决错误（禁用突出显示无法正常工作）。

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

Answer 5

Stylecop有很多评论规则，您可能还需要查看Stylecop+，因为这有一些方法/属性长度的额外规则。