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

【问题标题】：c# documentation/comments for immutable type classesc# 不可变类型类的文档/注释
【发布时间】：2016-09-22 23:04:48
【问题描述】：

您好，有什么方法可以在 c# 中为开发人员记录不可变类型的属性？

我知道您可以通过以下方式轻松记录类和对象本身：

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

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

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

我想要的是每个值的简短描述，例如 “x1 是我的对象的长度”和“x2 是高度”。我还想添加一些响应性的东西，例如，如果用户给 x1 输入“1”，x2 显示工具提示“长度”，但如果用户输入“2”作为输入，x2 显示“高度”工具提示。

【问题讨论】：

标签： c# documentation comments tooltip

【解决方案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)
    {}
}

更多可用的文档标签见here

【讨论】：