一千萬個為什麽

搜索

C#コメントテクニック/コメントの再利用

私は一般にプライベートフィールドとしてクラス內のフィールドを宣言しています。これは外部からこのフィールドにアクセスするpublicプロパティと一緒に宣言しています(これまで驚くべきことはありません smile )。

private bool doILookGood;

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

今私は同じコメントを2度書くことなくこの狀況をコメントするエレガントで効率的な方法があるのだろうかと思っていました。言い換えれば、IDEが私に変數コメントを表示しているという機能を保持したいのですが、ツールチップでマウスを動かしている間はコメントを表示します。

これまで私はこのようにコメントしています:

/// 
/// This i always true. ///
 
private bool doILookGood;

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

私はこのようなことをしたい:

/// 
/// This i always true. ///
 
private bool doILookGood;

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

プライベートフィールドにコメントするためにXMLタグを使用することは、生成されたドキュメントには表示されないので意味がありませんが、私は(IDE內部の)コメントツールチップを持ちたいだけです。

多分誰かがヒントを持っています:)

最佳答案

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

public bool DoILookGood { get; set; }

(例えば INotifyPropertyChanged を実裝する場合など)これができない場合は、以下のコードを使用します(例のためだけであり、以下のコードの代わりに自動プロパティを使用します)。

    /// 
/// Private member for . ///
 
    private bool myValue;

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

EDIT: I also recommend using GhostDoc to save time (a plugin that is able to automatically generate comments).

轉載註明原文: C#コメントテクニック/コメントの再利用