Question

Visual Studio中的工具提示非常有用，它们可以让您快速了解方法或类的用途。

我想知道我是否可以使用我的方法功能的简短摘要制作我自己的工具提示？

这是一张阐明我的意思的图片。

Answer 1

C＃编译器内置了此功能。
阅读https://msdn.microsoft.com/en-us/library/b2s063f7.aspx以了解更多信息。

举个例子：

/// <summary>
///     This is a description.
/// </summary>
public void Do()
{

}

Microsoft曾经使用 Sandcastle 创建他们的msdn文档网站。他们不再开发该工具，但可以自由使用。如果您想将C＃注释转换为Web文档，可以使用Sandcastle在编译时构建网站。如果您设计库或一般开源软件非常有用。

Answer 2

您要找的是summary。有关详细信息，请参阅此MSDN帖子。在visual studio中，您可以在方法/ peroperty之上键入三次/以添加其摘要。例如：

/// <summary>
/// Returns the sum of specified params
/// <param name="x">Operand 1</param>
/// <param name="y">Operand 2</param>
/// </summary>
private int GetSum(int x, int y)
{
    //logic
}

Answer 3

它们被称为XML注释。

例如：

/// <summary>  
///  This class performs an important function.  
/// </summary>  
public class MyClass{}

有关详细信息，请查看https://msdn.microsoft.com/en-us/library/b2s063f7.aspx

Visual Studio：我如何为自己的方法编写工具提示？

3 个答案: