如何查看xml-comments生成的完整文档

时间:2011-08-12 03:50:10

标签: c# visual-studio xml-comments

我写了一个方法,如:

/// <summary>
/// A method having xml-comments
/// This comment could be very long
/// </summary>
/// <param name="input">Input parameter</param>
/// <returns>Calculated value</returns>
int CommmentedMethod(int input) {
    return Calc(input);
}

但是当我使用这种方法时,Visual Studio(我正在使用VS 2010)只显示“一个有xml-comments的方法这个评论可能是...... ”而不是一个完整的文档。

是否可以选择显示它?

更新图片 enter image description here

谢谢: - )

4 个答案:

答案 0 :(得分:3)

您可以使用Ctrl + Shift + Space组合键查看参数信息。

在下面的屏幕截图中,您可以看到在使用格式化方法上的插入符号c + Ctrl + Shift + Space后显示的重载,定义和参数信息。

Parameter Information using Ctrl + Shift + Space

答案 1 :(得分:1)

如果使用ReSharper,可以按 CTRL + SHIFT + F1 。我不认为微软有这个功能。

答案 2 :(得分:1)

这可以在VS2010中使用,如上面的答案所示。它适用于VS2010,完全显示工具提示中的整个字符串。我建议你再次重新尝试一个新项目并重建项目并查看。 Intellisense通常使用最近使用过的工具提示文本。因此,如果你没有在第一次完成它并构建它,它将不会完全显示。重建项目应该可行。话虽如此,我只是尝试了你的代码,它就像一个梦想。所以,请尝试一个新项目并查看。

使用“快速信息”(将鼠标悬停在某个方法上时显示的工具提示)。这将在每行显示多个参数,因此能够显示更多参数而不会截断。

为工具提示设置较小的字体或字体大小。这可以通过转到工具 - >选项 - >环境 - >字体和颜色,在顶部的下拉列表中选择“编辑器工具提示”,并设置不同的字体和/或大小来更改。

P.S:但是如果你这样做会有一个问题。您是否从其他版本的Visual Studio迁移并转移设置。因为Visual Studio具有导入和导出设置的功能,您还可以包括智能感知设置。如果你这样做的话,这可能是我不知道的事情。

请为VS2010安装SP1,因为正如我所提到的那样,正在解决截断quickinfo的问题,减少字体大小!希望这可以帮助 !这一切都有效并经过验证!!

答案 3 :(得分:0)

VS2010 的工具提示将显示全部内容。我刚刚测试了新安装的VS2010,没有安装插件(Windows 7专业版)。

您可以尝试清除Automatically adjust visual experience based on client performance对话框Options...部分中的General标记,然后选中Enable rich client visual experience。关于它提供的确切内容的文档是模糊的,但我怀疑这可能会影响工具提示显示。