Visual Studio 的评论重花答案

【问题标题】：Comment reflower for Visual StudioVisual Studio 的评论重花
【发布时间】：2010-12-22 16:52:45
【问题描述】：

是否有可以在 Visual Studio 中重排 C# cmets 的内置命令或工具？

有时，一段代码需要几行 cmets，经过大量编辑后，您必须在适当的位置手动插入换行符，以免它流过编辑器窗口的右边缘。我希望能够用一个键命令来做到这一点。

使用 Visual Studio 多年后，我仍然怀念 emacs 中 M-q (c-fill-paragraph) 的功能。

编辑：Agent Smith 插件不会重排方法主体中的 cmets。

【问题讨论】：

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

【解决方案1】：

当我还是一名 Visual C++ 开发人员时，我编写了一个相当可配置的注释格式化工具，称为 Comment Reflower。从那以后我已经更换了平台，因此停止了移植，但幸运的是 Christoph Nahr 在 http://www.kynosarges.de/CommentReflower.html

上保持了它的活力

【讨论】：

多年来我一直在使用 Comment Reflower，我非常喜欢它。它为 cmets 提供了近乎完美的理由。我刚刚在此页面中添加了说明，以使其在 Visual Studio 2012 中运行。
仅供参考，为方便起见，我将托管 fork at GitHub incl。 Christoph Nahr 的变化。

【解决方案2】：

如果您想通过一次按键获得近乎完美的评论理由，请使用Comment Reflower。

适用于 VS2012、VS2013 和 VS2015。

VS2012：为 Visual Studio 2012 安装/升级 Comment Reflower

2015 年 8 月 31 日更新：现在扩展库中有一个 Comment Reflower extension 可用，可以在 VS2012、VS2013 和 VS2015 中直接从 Tools > Extensions and Updates 轻松安装。

从http://www.kynosarges.de/CommentReflower.html下载“评论重花”，解压到目录C:\Program Files (x86)\Visual Studio Comment Reflower。
更新文件CommentReflower.Addin，使Version从10.0增加到11.0（这会将它从VS2010升级到VS2012）。注意：此 .xml 文件中有两个点，您必须在其中更新此版本。
在VS2012中，选择Tools..Options..AddIn Security并添加路径C:\Program Files (x86)\Visual Studio Comment Reflower。
重启VS2012。
现在有新的菜单项：Tools..Reflow Comment at Cursor 和 Tools..Comment Reflower Settings。

VS2013：为 Visual Studio 2013 安装/升级 Comment Reflower

2015 年 8 月 31 日更新：现在扩展库中提供了一个 Comment Reflower 扩展，可以在 VS2012、VS2013 和 VS2015 中直接从 Tools > Extensions and Updates 轻松安装。

重复上述说明，并将步骤 2 中的版本从 11.0 更改为 12.0。

VS2015：为 Visual Studio 2015 安装/升级 Comment Reflower

现在扩展库中有一个Comment Reflower extension 可用，可以在VS2012、VS2013 和VS2015 中直接从Tools > Extensions and Updates 轻松安装。

感谢@Martin Liversage 指出这一点。

要添加一个快捷键来证明您的光标所在的当前评论是正确的

转到Tools..Options..Keyboard，在Show commands containing 中输入reflow，选择CommentReflower.Connect.ReflowPoint，在Press shortcut keys 框中输入组合键（例如Ctrl-J），然后点击Assign。
现在，如果您将光标放在评论上，然后按所述组合键 (Ctrl-J)，它会自动（并且漂亮地）为您证明评论的合理性。您应该会看到绑定键出现在Tools 菜单中：

更新边距宽度

进入Tools..Comment Reflower Settings并将Wrap Width从默认的80更改为更宽的值，例如140，并将“最小块宽度”更改为10（将*not*设置为更小的值！）：

【讨论】：

此描述也适用于 Visual Studio 2013，只是第 2 项中的版本应更改为 12.0。
我刚试过这个，除了按 CTRL + J 之外的所有东西都可以。知道为什么不？
@Jon Cage 我认为您必须点击“分配”（上面添加快捷键部分的第 2 步）。点击“确定”而不点击“分配”实际上不会绑定密钥。此外，有时如果它已经被证明是合理的，那么它似乎不会做任何事情，所以要测试它是否有效，通过创建一条大线来证明它，然后再次点击“Reflow Comment At Cursor”。
扩展库中现在有一个Comment Reflower 扩展，可以直接从VS2012、VS2013 和VS2013 中的工具 > 扩展和更新轻松安装VS2015.
太棒了，太棒了！我已更新答案以反映此评论。

【解决方案3】：

如果你使用 ReSharper，有免费的 Agent Smith 插件可以回流 cmets。

【讨论】：

谢谢，我试过了。代理 Smith 能够重排 XML cmets（成员前面的 '///' cmets），但不能重排成员内部的 cmets。我认为这将在某个时候得到解决。
Agent Smith NuGet 包的链接位于resharper-plugins.jetbrains.com/packages/AgentSmith。

【解决方案4】：

如果您使用 // 或 ///-style cmets CodeMaid 对我来说效果很好。它是免费和开源的，我可以在 C++ 和 C# 中使用它。

【讨论】：