我可以使用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(及其附近的相关警告).将其严重性更改为错误,它可能对您有所帮助 - 但很难说您处于不寻常的环境中.