c# - Visual Studio IDE Helper/Summary - 通过构造函数传递对象的引用名称

Question

我在下面有一个示例脚本，它是通用的，以避免创建许多只存储两个属性的类。但是，当使用多个实例时，所有 .x .y 等引用都会变得更难跟踪。尤其是在重新访问一个项目时。

我想知道是否可以在 IDE 中添加某种帮助程序。将鼠标悬停在其中一个变量字段上时会添加摘要的东西，该字段引用通过公共构造函数传递的对象的名称。

例如，如果实例化 Example(id, someObject)。键入对象点“x”时，将有一个名称为“ID”的摘要。和带有点“y”的“someObject”。

class Example<X, Y>
{
    public X x;
    public Y y;

    public Example(X x, Y y)
    {
        this.x = x;
        this.y = y;
    }
}

这样的事情可能吗？或者创建通用样式对象只是一般的坏习惯？

先感谢您 ：）

**编辑

在回复当前的反馈时，我对大部分可用的 /// 汇总属性都比较熟悉。

但我想要这样的事情。我认为这是无法实现的。不过觉得最好还是问问以防万一。

标签： c#visual-studio-2010attributes

Answer 1

/// <summary>
/// My Class.
/// </summary>
/// <typeparam name="X"></typeparam>
/// <typeparam name="Y"></typeparam>
class Example<X, Y>
{
    /// <summary>
    /// My Var 1
    /// </summary>
    public X x;

    /// <summary>
    /// My Var 2
    /// </summary>
    public Y y;

    /// <summary>
    /// My Example.  This will be displayed anytime you hover over where the example is called.
    /// </summary>
    /// <param name="x">My first param.</param>
    /// <param name="y">My second param.</param>
    /// <remarks>Some extra into.</remarks>
    /// <example>This is how you use it.</example>
    public Example(X x, Y y)
    {
        this.x = x;
        this.y = y;
    }
}

每当您使用这些元素中的任何一个时，您都可以将鼠标悬停在名称上，然后会出现注释文本。

只需///在任何类、变量或方法上方开始输入，注释就会自动生成。

请参阅https://docs.microsoft.com/en-us/visualstudio/ide/reference/generate-xml-documentation-comments?view=vs-2019