如何获取 Visual Studio 快速注释以在双斜杠后添加 space 以避免 SA1005?

How to get Visual Studio quick comments to add a space after the double slash to avoid SA1005?

在Visual Studio中,我有一段代码。我突出显示它并使用 Ctrl+k+c 注释掉该块。在我突出显示的每一行的开头添加“//”。然后我尝试提交我的代码...并且我 运行 进入 StyleCop 规则 "SA1005",该规则要求所有 // 后跟 space 或更改为 ////。我真的很想修改 Visual Studio 以便 ctrl+k+c 添加“//”。我还没有找到实现这一目标的任何扩展或选项。有谁知道进行这种更改的方法(除了编写我自己的新 VS 扩展之外)?

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

我的同事告诉我,您也可以直接按 Ctrl+K+C Ctrl+K+C(即应用注释两次),就可以了////code。这将通过 StyleCop。执行两次取消注释快捷键以撤消。显然,StyleCop 不关心在四个斜杠之后是否有 space,只在两个斜杠之后。

看来有些人很喜欢这种规则行为。人们会用一组 // 注释掉代码,如果他们正在玩东西但不想忘记并以这种方式检查它。 SA 会失败,代码也不会进去。一旦你真的想把代码注释掉并签入,那么你再把它注释掉就可以了。他们声称,这使许多人免于签到错误。