c# - 如何在 C# 中向类、方法、属性等添加文档工具提示？

Question

不确定我是否正确地调用了这个，但我想开始向我的类、方法、属性等添加一些文档。我知道这可能非常明显，但我从未真正学到它。我不知道从哪里开始。

只是为了澄清，无论何时滚动一个类(或方法、属性等)，它都会在 Visual Studio 中显示一个工具提示，其中包含有关该特定方法的一些文档。

class Microsoft.Phone.BackgroundAudio.BackgroundAudioPlayer
Provides background access to audio playback functionality such as play, pause, fast-forward, and rewind.

它叫什么，我如何在我的 C# 应用程序中实现它？

Answer 1

您可以使用///或 GhostDoc

编辑:

在第一种情况下你会得到

/// <summary>
/// 
/// </summary>
class A
{
    /// <summary>
    /// 
    /// </summary>
    public A() { }

    /// <summary>
    /// 
    /// </summary>
    public int Property { get; set; }

    /// <summary>
    /// 
    /// </summary>
    /// <param name="obj"></param>
    public void Method(object obj) { }
}

第二个

/// <summary>
/// 
/// </summary>
class B
{

    /// <summary>
    /// Initializes a new instance of the <see cref="B"/> class.
    /// </summary>
    public B() { }

    /// <summary>
    /// Gets or sets the property.
    /// </summary>
    /// <value>
    /// The property.
    /// </value>
    public int Property { get; set; }

    /// <summary>
    /// Methods the specified obj.
    /// </summary>
    /// <param name="obj">The obj.</param>
    public void Method(object obj) { }
}