2016-05-25 8 views
0

こんにちは、C#の開発者の不変型のプロパティを文書化する方法はありますか?不変型クラスのドキュメント/コメント

私はあなたが簡単にクラスを文書化することができます知っていると自分自身をオブジェクト:

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

しかし、私は新しいオブジェクト作成した場合、どのように私は、ポップアップメニューのエントリを行うことができます。

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

私は何だろうが好きなのは、各値の簡単な説明です。例えば、 "x1は私のオブジェクトの長さ"、 "x2は高さ"です。また、ユーザーがx1の入力として「1」を、x2が「長さ」のツールチップを表示した場合など、応答性のあるものを追加したいと思いますが、ユーザーが入力として「2」を入力した場合、x2はツールチップ。あなたのコンストラクタの上

答えて

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

関連する問題