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

Question

您有没有办法在c#中为开发人员记录不可变类型的属性？

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

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

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

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

我想要的是每个值的简短描述,例如"x1是我的对象的长度"和"x2是高度".另外我想添加一些响应的东西,例如,如果用户为x1输入"1",x2显示工具提示"长度",但如果用户输入"2"作为输入,则x2显示"高度"工具提示.

Answer 1

在构造函数上方添加以下内容:

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)
    {}
}

有关更多可用文档标记,请参阅此MSDN文章