有没有一种很好的方法可以在Visual Studio中显示长XML注释而无需导航到定义？

Question

显示注释的工具提示很方便，但是对于长注释，工具提示变得无用，因为它只持续几秒钟，并且注释沿着一条线延伸，直到它从最后运行。

可以通过导航到定义来获取评论，但这很烦人，因为它打开标签来源我不工作的文件，并且弄乱了前进/后退导航历史记录。它还会遇到您正在查看XML（必须是escaped）而不是格式良好的文档的问题。

我真正希望看到的是Eclipse如何显示javadoc注释。这个blog post显示了Visual Studio和Eclipse中类似类的工具提示的比较。

Visual Studio是否存在这样的模式或插件？

Answer 1

您可以使用<para>标记将xml注释放在多行上。这样您的长评论就不会在屏幕边缘消失：

/// <summary>
/// <para>First line of your comment</para>
/// <para>Second line of your comment</para>
/// </summary>

关于这些工具提示的延迟;这是一个长期运行的Visual Studio请求，仍然没有修复。最近请求here，甚至回到2004年，here。

Answer 2

我使用GhostDoc在我的代码上自动生成XML注释，这一点特别有用，因为您不会花太多时间重新生成注释，这有助于使API信息一致。

有几点想法：

您可以在评论中使用超链接，如下图所示。这可能指向一个帮助系统：

您可以将其与SandCastle结合使用，这是一篇很棒的文章Creating documentation for a Net component with Sandcastle Help File Builder：

  

默认情况下，禁用从注释中创建XML文件。   它应该在Build选项卡的项目属性中启用。

  

因此，每次构建时都会创建一个XML文件   可执行或汇编。该文件将包含所有XML注释   来自代码，包括对所有非公共实体的评论。这个   文件本身很有用，因为当你把它放在程序集旁边时，   Visual Studio中的IntelliSense功能将使用来自的信息   此文件显示方法，属性和的描述   装配参数。这是一个如何寻找的例子   上面显示的函数GetR：