如何查看xml-comments生成的完整文档 [英] How to see full document generated by xml-comments

问题描述

我写了一种方法，例如:

I have writen a method such as:

/// <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注释的方法，此注释可能是... "，而不是完整的文档.

But when I use this method, Visual Studio (I'm using VS 2010) just show up "A method having xml-comments This comment could be..." not a full document.

有显示它的选项吗?

更新的图片:

谢谢:-)

推荐答案

您可以使用Ctrl + Shift +空格键组合来查看参数信息.

You can use Ctrl + Shift + Space key combination to view the parameter information.

在下面的屏幕截图中，您可以看到在使用Ctrl + Shift +空格的情况下，使用插入号on Format方法显示了重载，定义和参数信息.

In the following screenshot you can see the overloads, definition and parameter information being shown after clicing Ctrl + Shift + Space with the caret on Format method.

这篇关于如何查看xml-comments生成的完整文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！