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

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

例如，我希望确保所有方法或函数上面都有注释说明：

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

//
///这里是MyMethod的描述。
/// 
公共方法（）；

---

我还希望看到一个基本的检查（代码行数）/（注释行数）是否在某个神奇的快乐媒介附近，如果不是，则创建一个通知或警告。

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

当然，这不能保证评论是好的。。。但这将确保它们的存在

---

编辑：R#确实有此设置-在“代码检查”、“检查严重性”、“C#”、“编译器警告”下，查找CS1591:缺少公共可见类型或成员的XML注释（及其附近的相关警告）。将其严重性更改为错误，可能会对您有所帮助-但很难说，因为您处于一个不寻常的环境中。

不要与Jon竞争，而是按照您所描述的去做

---

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

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

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

代理服务器（适用于R#9）。现在，我的ReSharper的扩展管理器说，这个扩展是针对9.0版（我已经安装）的ReSharper的，但事实上，这个扩展会出现错误（禁用高光不能正常工作）

针对ReSharper 9的XML文档检查。看起来，工作没有任何问题（我刚刚安装）。这就是您真正需要突出显示没有XML注释的类、方法、属性等（甚至是私有字段）的地方

---

+1对于一个好的“尽力而为”的解决方案，虽然它可以提供自动记录的良好尝试，但它仍然不能保证开发人员所做的更改是好的更改…@基本感谢，本质上签入策略是版本控制的质量关口，在签入和生成代码之前必须完成的任务。例如，确保代码更改不会引入回归错误的测试策略，确保签入代码符合某些约定标准的代码分析策略，以及减少范围扩展并帮助测试人员查明应用程序任何给定版本中包含的内容的工作项策略。@Jeremythonpson GhostDoc在VS2012及更高版本中是否仍有大量用途？您可以在任何方法上方键入“//”，它将自动生成供您填写的注释标准。@S.Richmond GhostDoc还将为标记生成文本，不仅仅是标签本身。在正常情况下，问题第一部分的解决方案非常简洁-但是我特别需要一个R#解决方案，因为我们使用的是Unity3D引擎，它不使用Visual Studio来执行项目的构建，因此，我无法充分利用上述内容。@S.Richmond：我很困惑-R#是一个Visual Studio插件。如果您不使用VS，您将如何使用R#？此外，我见过的每一个C#编译器都能够生成XML文档输出——您是否寻找过这个选项？它不是特定于VisualStudio的。例如，使用mcs（Mono C#编译器）可以使用

-doc

参数。最后，如果您有一些奇怪的需求，您应该在问题中首先考虑它们。不，我们使用的是VS2012，但是Unity3D仅将其用作IDE。Unity3D自己执行构建。出于这个原因，我的问题特别提出了一个R#解决方案。@S.Richmond：如果你根本没有做内置VS，那么我最希望R#能够做的就是在文件打开时添加曲线，并可能显示错误。但是，我希望您能够生成文档，作为构建的一部分。（当您在Visual Studio中点击Build时会发生什么情况？这会自动启动Unity3D构建而根本不涉及MS编译器吗？所有这些都应该在问题中解释…）抱歉，鉴于问题对R#的具体程度，我认为这些信息不相关。不幸的是，在这种情况下，仅仅为了检查代码注释是否令人满意而进行构建有点麻烦。如果有一个基于R#的解决方案能够与已经存在的其他代码标准规则相适应，那就太好了。