如何使Visual Studio intellisense显示XML注释的备注部分?

时间:2011-12-27 14:31:57

标签: visual-studio-2010 intellisense xml-comments summary remarks

在输入代码时,我非常喜欢Visual Studio 2010(Professional)的intellisense功能,特别是我能够查找正在使用的类型的XML注释。 (见Documentation from Microsoft)。这项工作到目前为止。 但是,XML代码注释的备注部分未显示。

我认为这是一个非常有用的功能,因为通常有用的信息无法从摘要中轻易猜到。 (这就是为什么我们有备注部分,我猜)

如何在智能感知级别探索Visual Studio 2010(专业版)中的备注部分?(我使用DevXpress Coderush,如果这很重要,但我不这么认为)。

2 个答案:

答案 0 :(得分:4)

Visual Studio v16.6.5在“文本编辑器> C#>高级>编辑器帮助”中具有一个选项,称为“在快速信息中显示备注”。它是最近才添加的,默认情况下已启用,但是我还没有找到任何发行说明或文档。我检查了16.5.2版,它没有这样的选项。

启用后,快速信息会在添加段落分隔符(空行)后显示备注部分。如果没有 summary 部分,则仍会在备注之前添加段落分隔符(不确定是否是故意的)。

returns 部分现在也显示类似,在 remarks 部分之后,由单词“ returns”分隔。但是似乎没有禁用此选项的选项。

答案 1 :(得分:3)

将光标放在类/函数/您要查看完整注释的任何内容上,然后按F12。展开编辑器窗格左侧的注释部分。