ReSharper - 如何在代码清理中禁用垃圾文档标题的生成答案

【问题标题】：ReSharper - how to disable generation of rubbish documentation headers in Code CleanupReSharper - 如何在代码清理中禁用垃圾文档标题的生成
【发布时间】：2011-12-31 05:07:55
【问题描述】：

我们将 ReSharper 6.0 与 StyleCop 一起用于 ReSharper。

虽然我们使用 StyleCop 规则，即成员必须有文档标头，但我们不希望 ReSharper 的代码清理工具为我们生成文档标头，因为它们不可避免地是垃圾。糟糕的文档标题比没有更糟糕，因为它们更不可能被更新而不是首先添加。

我们尝试在 ReSharper => 选项 => 工具 => StyleCop 中关闭“将文本插入文档和文件头”设置，但是当您重新启动 Visual Studio 时它会自行重置。

有什么想法可以阻止 Code Cleanup 为我们创建文档标题吗？

【问题讨论】：

标签： resharper stylecop resharper-6.0 code-documentation

【解决方案1】：

ReSharper -> Options -> Tools section -> Code Cleanup -> select StyleCop profile -> Documentation section -> untick 1600.

将阻止创建默认文档标题，但 StyleCop 仍将强制它们应该存在。

【讨论】：

对我来说，我必须将1639: Update file header 设置为Do not change。
另外，如果您使用的是自定义文件头，并且不想将其替换为标准 StyleCop 头，请取消选中 StyleCop -> 文档下的 1633-1641: Update file header。

【解决方案2】：

阻塞代码生成之后的第二步是删除垃圾。我通过 Visual Studio 使用了正则表达式搜索/替换。

正则表达式用于标题：

// ---.*\r\n\/\/.*\r\n\/\/.*\r\n\/\/.*\r\n\/\/.*\r\n\/\/.*\r\n.*\r\n\/\/.-{116}

正则表达式删除生成的摘要

\s{4}\/\/\/\s<summary>(.*)\r\n.*\r\n.*</summary>

注意：它将删除所有摘要，甚至是好的摘要，因此在启动之前检查替换范围。（git checkout 可能是你的朋友......）

【讨论】：