c# - 如何添加鼠标悬停摘要

Question

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

类 System.String

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

当我将鼠标悬停在我的一个课程上时，它只是说：

类 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

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

不要在摘要描述中使用和号 ( &) 或尖括号 ( )。<

休息：

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

三斜杠 XML 注释可用于在 Visual Studio 中创建 IDE 工具提示。尤其是“总结”和“例外”的效果非常好。（“代码”之类的其他内容在我使用的 Visual Studio 版本中不起作用。）

如果这对您不起作用，那么您的设置可能有问题。

Answer 4

在 Visual Studio 中重置您的设置，它们似乎搞砸了。为了让它出现，你必须使用第一个例子。

Answer 5

您需要使用您的第一个语法，并且，如果您在 Visual Studio 解决方案之外使用该类，您需要在项目属性中选中生成 XML 文档文件。

Answer 6

除了上述答案之外，请访问Microsoft 文档链接以获取完整的标签列表，从而为您的课程做出非常漂亮的总结。