C# VisualStudio：如何为自己的方法编写工具提示？

VisualStudio中的工具提示非常有用，它们可以让您快速澄清方法或类的用途

我想知道我是否可以通过对我的方法的功能的简短总结来制作我自己的工具提示

这里有一张图片来阐明我的意思

---

它们被称为XML注释

例如：

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

/// <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
}

//
///这个类执行一个重要的函数。
///   
公共类MyClass{}

有关更多信息，请查看此处

C#编译器内置了此功能。
阅读以了解更多信息

例如：

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

}

//
///这是一个描述。
/// 
公营部门
{
}

微软曾经使用Sandcastle创建他们的msdn文档网站。 他们不再开发该工具，但它可以自由使用。

---

如果你想把你的C#评论变成一个网络文档，你可以使用Sandcastle在编译时构建网站。如果您设计库或通用开源软件，这将非常有用

您要查找的内容称为

摘要

。有关详细信息，请参阅本文。在visual studio中，您可以在方法/peropery上方键入三次

/

，以添加其摘要。例如：

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

/// <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
}

//
///返回指定参数的总和
///操作数1
///操作数2
/// 
私有整数GetSum（整数x，整数y）
{
//逻辑
}

XML commnets您的意思是什么？就在方法（或属性或类）的第一行之前键入一个三重斜杠（///+Enter），然后用方法的描述填充它。他们被称为非常感谢much@slipped_disk不客气：）请确保也使用其他xml标记。summary标记不是唯一的一个。您还可以引用参数和其他类型。请确保已启用项目属性中的xml文件生成。如果关闭此选项，其他项目将无法看到工具提示@我很确定这只适用于直接引用dll的情况。据我所知，从同一解决方案中引用项目没有此约束。但是，如果部署库，则应该启用此选项，并使用dll部署xml。