2

私は通常、クラス内のフィールドをプライベートフィールドとして宣言し、外部からこのフィールドにアクセスするパブリックプロパティを宣言しています（これまでのところ、目を見張るものはありません）：

private bool doILookGood;

public bool DoILookGood
{
   get { return doILookGood; }
   set { doILookGood = value; }
}

同じコメントを 2 回書くことなく、この状況にコメントするエレガントで効率的な方法があるかどうか疑問に思っていました。言い換えれば、ツールチップでマウスをホバリングしているときに、IDE が変数のコメントを表示するという機能を保持したいと考えています。

これまでのところ、私はこのようにコメントしています：

/// <summary>
/// This i always true.
/// </summary>
private bool doILookGood;

/// <summary>
/// This i always true.
/// </summary>
public bool DoILookGood
{
   get { return doILookGood; }
   set { doILookGood = value; }
}

そして、私はこのようなものが欲しいです:

/// <summary>
/// This i always true.
/// </summary>
private bool doILookGood;

/// <summary cref="doILookGood" />
public bool DoILookGood
{
   get { return doILookGood; }
   set { doILookGood = value; }
}

生成されたドキュメントには表示されないため、プライベート フィールドのコメントに XML タグを使用してもあまり意味がないことはわかっていますが、(IDE 内部の) コメント ツールチップのみが必要です。

多分誰かが手がかりを持っています:)

4

1 に答える 1

6

可能な限り自動プロパティを使用します。これにより、不要なときにプライベートメンバーを使用する必要がなくなります。

public bool DoILookGood { get; set; }

それが不可能な場合（たとえば、を実装する場合INotifyPropertyChanged）、これが私がそれを処理する方法です（これは単なる例であり、以下のコードの代わりに自動プロパティを使用することに注意してください）：

    /// <summary>
    /// Private member for <see cref="MyValue"/>.
    /// </summary>
    private bool myValue;

    /// <summary>
    /// Gets or sets a value indicating whether ...
    /// </summary>
    /// <value>
    ///   <c>true</c> if ...; otherwise, <c>false</c>.
    /// </value>
    public bool MyValue
    {
        get { return this.myValue; }
        set { this.myValue = value; }
    }

編集：時間を節約するためにGhostDoc（コメントを自動的に生成できるプラグイン）を使用することもお勧めします。

于 2011-12-26T13:15:02.967 に答える