如何让 Visual Studio 快速注释在双斜杠后添加空格以避免 SA1005？答案

【问题标题】：How to get Visual Studio quick comments to add a space after the double slash to avoid SA1005?如何让 Visual Studio 快速注释在双斜杠后添加空格以避免 SA1005？
【发布时间】：2015-04-18 11:31:29
【问题描述】：

在 Visual Studio 中，我有一段代码。我突出显示它并使用 Ctrl+k+c 注释掉该块。这会在我突出显示的每一行的开头添加“//”。然后我尝试提交我的代码......我遇到了 StyleCop 规则“SA1005”，该规则要求所有 // 后跟一个空格或更改为 ////。我真的很想修改 Visual Studio 以便 ctrl+k+c 添加“//”。我还没有找到任何可以实现这一点的扩展或选项。有谁知道进行这种更改的方法（没有编写我自己的新 VS 扩展）？

【问题讨论】：

标签： visual-studio visual-studio-2012 comments stylecop

【解决方案1】：

我的同事告诉我，你也可以直接按 Ctrl+K+C Ctrl+K+C（即应用两次注释），它会做////code。这将通过 StyleCop。取消注释快捷键两次以撤消。显然，StyleCop 不在乎四个斜线后是否有空格，只在两个斜线之后。

似乎有些人真的很喜欢这种规则行为。人们会用一组// 注释掉代码，如果他们正在玩弄东西但不想忘记并以这种方式检查它。 SA 将失败，代码将无法进入。一旦您真的打算将代码注释掉并签入，那么您再次将其注释掉，您就可以开始了。他们声称，这使许多人免于入住失败。

【讨论】：

【解决方案2】：

您不需要编写自己的 VS 扩展，我们已经提供了插件 GhostDoc - 欢迎您使用免费版本 - 它将生成符合 StyleCop 的 XML 注释模板（您也可以调整） . GhostDoc 也像 VS 一样在三斜杠 (///) 上生成 cmets。

【讨论】：

不错的插件。 GhostDoc 非常好。但是，这并不能解决 OP 在 // 之后插入空格的问题，我还注意到，虽然 GhostDoc 使 /// <spaced...> cmets 具有吸引力，但在 GhostDoc 生成的注释块中编写多行 <example> 时，添加一个新行默认 Visual Studio 默认为 /// 没有空格，使得输出非常没有吸引力。
我同意 GhostDoc 是一个很棒的工具。但是这个问题与 XML Documentation cmets 无关。
这不回答 OP 问题，而是宣传您的工具。