Visual studio 有没有一种很好的方法可以在VisualStudio中显示长XML注释而无需导航到定义?
显示注释的工具提示非常方便,但对于较长的注释,工具提示将变得毫无用处,因为它只持续几秒钟,注释将沿着一条直线拉伸,直到结束 可以通过导航到定义来访问注释,但这很烦人,因为它会打开指向我未处理的源文件的选项卡,并将前向/后向导航历史记录弄乱。它还存在一个问题,即您正在查看XML(必须是),而不是格式良好的文档 我真正想看到的是Eclipse如何显示javadoc注释。这显示了VisualStudio和Eclipse中类似类的工具提示的比较Visual studio 有没有一种很好的方法可以在VisualStudio中显示长XML注释而无需导航到定义?,visual-studio,visual-studio-2010,Visual Studio,Visual Studio 2010,显示注释的工具提示非常方便,但对于较长的注释,工具提示将变得毫无用处,因为它只持续几秒钟,注释将沿着一条直线拉伸,直到结束 可以通过导航到定义来访问注释,但这很烦人,因为它会打开指向我未处理的源文件的选项卡,并将前向/后向导航历史记录弄乱。它还存在一个问题,即您正在查看XML(必须是),而不是格式良好的文档 我真正想看到的是Eclipse如何显示javadoc注释。这显示了VisualStudio和Eclipse中类似类的工具提示的比较 Visual Studio是否存在这样的模式或插件?您可以
Visual Studio是否存在这样的模式或插件?您可以使用
标记将xml注释放在多行上。这样,您的长篇评论就不会从屏幕边缘消失:
/// <summary>
/// <para>First line of your comment</para>
/// <para>Second line of your comment</para>
/// </summary>
//
///你评论的第一行
///你评论的第二行
///
关于那些工具提示的延迟;这是VisualStudio长期运行的请求,但尚未修复。最近一次请求,甚至是在2004年,。我用于在代码上自动生成XML注释,这非常有用,因为您不需要花费太多时间重新生成注释,而且它有助于使API信息一致
有几个想法:
您可以在评论中使用超链接,如下图所示。这可能指向一个帮助系统:
您可以将其与以下文章结合使用:
默认情况下,将禁用从注释创建XML文件。
应该在“生成时的项目属性”选项卡中启用它
因此,将在您的每个版本上创建一个XML文件
可执行文件或程序集。该文件将包含所有XML注释
来自代码,包括所有非公共实体的注释。这
文件本身很有用,因为当您将其放在程序集旁边时,
Visual Studio中的IntelliSense功能将使用来自
此文件用于显示方法、属性和属性的说明
组件的参数。下面是一个它将如何寻找的示例
函数GetR如上图所示:
我对你的问题没有“真实”的答案,但你试过这个方法吗?这可能会对您有所帮助。这非常有帮助,因为它可以快速访问注释所在的代码(并且无需打开新选项卡)。它没有解决工具提示的限制,但我想我会开始使用它。