如何添加鼠标悬停摘要

Question

我几乎可以肯定这将是一个非常简单的答案，但我似乎无法在任何地方找到它。我们都知道当你将鼠标悬停在某些东西（如字符串）上时会弹出一个小摘要（如果已启用）。对于一个字符串，它说：

  

class System.String

     

将文本表示为一系列Unicode字符。

当我将鼠标悬停在其中一个我的类上时，它只是说：

  

class Namespace.Widget

我已经尝试过我发现的两个明显的例子：

/// <summary>
/// This summary does not work, I know it's for html documenting tools but thought it was worth a shot.
/// </summary>

和

// Summary:
//     This is what is in some of the base libraries, and does not work as well.

那么，如何在鼠标悬停弹出窗口中添加摘要？

Answer 1

我不明白为什么你的第一次尝试不起作用。这是<summary>评论标记，它提供了您正在谈论的“工具提示”......

/// <summary>
/// This text should automatically show up as the summary when hovering over
/// an instance of this class in VS
/// </summary>
public class MyClass
{
    public MyClass() {}      
}

public class MyClass2
{
    public MyClass()
    {
        //hovering over 'something' below in VS should provide the summary tooltip...
        MyClass something = new MyClass();
    }
}

如果您想要帮助自动化某些评论，请尝试免费的GhostDoc。到目前为止，最好的免费VS插件之一..

Answer 2

三斜杠XML注释可用于在Visual Studio中创建IDE工具提示。特别是，“摘要”和“例外”工作得非常好。 （其他类似“代码”的东西在我使用的Visual Studio版本中没有用。）

如果这不适合您，那么您的设置可能出现问题。

Answer 3

我刚刚发现的另外两个检查项将阻止在悬停时显示摘要：

请勿在摘要说明中使用“＆”号（&）或起始尖括号（<）。

断裂：

    ///<summary>
    ///Class does this & that
    ///</summary>

代替使用：

    ///<summary>
    ///Class does this AND that
    ///</summary>

断裂：

    /// <summary>
    /// Checks if this < that
    /// </summary>

这将起作用，但可能不是一个很好的先例：

    /// <summary>
    /// Checks if this > that 
    /// </summary>

---

请勿将///行彼此分开。

断裂：

    /// <summary>
    /// This text will not show
    
    /// </summary>

断裂：

    /// <summary>
    /// This text will also not show
    //  - This line only has 2 dashes
    /// </summary>

作品：

    /// <summary>
    ///
    /// This
    ///
    /// is fine.
    ///
    /// </summary>

Answer 4

在visual studio中重置您的设置，它们似乎搞砸了。要显示它，你必须使用第一个例子。

Answer 5

您需要使用第一种语法，如果您使用的是Visual Studio解决方案之外的类，则需要选中“项目属性”中的“生成XML文档”文件。

Answer 6

除了上述答案外，请访问Microsoft docs link以获取标记的完整列表，以为您的课程做一个非常漂亮的摘要。