c#不可变类型类的文档/注释

时间:2016-05-25 11:17:33

标签: c# documentation comments tooltip

您好有办法在c#中记录开发人员的不可变类型的属性吗?

我知道您可以使用以下方法轻松记录类和对象:

  /// <summary>
  /// This is an object
  /// </summary>

但是如果我创建一个新对象,如何为popupmenu创建一个条目:

Myobject ob1 = new Myobject(x1,x2,.....);

我想要的是对每个值的简短描述,例如 &#34; x1是我的对象的长度&#34;和&#34; x2是高度&#34;。另外,我想添加一些响应性的东西,例如,如果用户给出了&#34; 1&#34;作为x1的输入,x2显示工具提示&#34;长度&#34;但是如果用户给出&#34; 2&#34;作为输入,x2显示&#34; height&#34;在工具提示中。

1 个答案:

答案 0 :(得分:5)

在构造函数上方添加:

public class Myobject
{
    /// <summary>
    /// Initializes a new Myobject instance
    /// </summary>
    /// <param name="x1">The x1 parameter does something</param>
    /// <param name="x2">The x2 parameter does another thing</param>
    public Myobject(int x1, int x2)
    {}
}

有关更多可用文档标记,请参阅this MSDN article