c# documentation/comments 不可变类型 类

c# documentation/comments for immutable type classes

您好,有什么方法可以为 C# 中的开发人员记录不可变类型的属性吗?

我知道您可以轻松记录 类 和对象本身:

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

但是,如果我创建一个新对象,如何为弹出菜单创建一个条目:

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

我想要的是对每个值的简短描述,例如 "x1 is the length of my object" 和 "x2 is the height"。我还想添加一些响应性的东西,例如,如果用户输入“1”作为 x1,x2 显示工具提示 "Length",但如果用户输入“2”,x2 显示 "height" 在工具提示中。

在构造函数上方添加:

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

有关更多可用文档标签,请参阅 here