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

Question

最近经常使用 ReSharper，我想为我的团队设置的一件事是在 C# 类或 C# 文件没有设置代码注释标准时发出通知。不幸的是，我还没有找到很多关于这个主题的信息。

例如，我想确保所有方法或函数的上方都有注释说明:

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

我还希望看到对(代码行数)/(评论行数)是否围绕某种神奇的快乐媒介进行基本检查，如果不是，则创建通知或警告。

Answer 1

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

当然，它不会确保评论良好......但它会确保它们存在。

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