web-dev-qa-db-ja.com

VS 2010で変数/フィールド/リストのコメント/ドキュメントを書く方法は？

有る

///<summary>
///This is summary for some class or method
///</summary>

クラスまたはメソッドのドキュメント。しかし、これを単純な変数またはリストに対してどのように書くのですか？

私はVisual Studio 2010を使用しており、リスト、プロパティ、または何らかの要約（その小さなツールチップ内）を表示したいものにカーソルを合わせると、その特定のものに書き込みました。

///<doc>
///always use this list!
List<String> beer = new List<String>();

編集：わかりました、それはあなたのクラスでコメントしている限り通常どおり機能しますが、メソッドまたは関数の外側にあることがわかりました!!

メソッド内でドキュメント化/コメントする方法もありませんか？

public class BeerForall
{
    /// <summary>
    /// it works here
    /// </summary>
    public List<String> beer = new List<string>();

    public String giveBeer()
    {
        /// is not working, u can not comment
        /// <summary>
        /// test test, not working
        /// </summary>
        List<String> moreBeer = new List<string>();

        return "beer";
    }
}
c#.netvisual-studiovisual-studio-2010xml-documentation
19
Gero

Visual Studio 2010では完全に問題なく動作するようです。MainFormクラス内にコメント付きのプライベートフィールドとしてリストを定義しました。

ただし、関数内で定義されたローカル変数では機能しません。

enter image description here

12
gideon

他の人が述べたように、ローカル変数のIntelliSenseを取得することはできません。ただし、関数が大きすぎて「通常の」コメントが、varを使用している場所の近くを読むのに十分近くない場合は、正しい修正は関数をリファクタリングすることです-ブレーク変数の数が少ない、複数のより小さなメソッドに分類されます。この機能すべきは存在しないと思います。これは、過度に大きな関数を簡単に記述できるようにするためです。

12
Craig Stuntz

私の知る限り、インテリセンスへのコメントの追加は、関数内で宣言されたローカル変数に対しては機能しません。ローカルリストをクラスのインスタンス変数にする場合、これを行うことができます。

6
ooPeanutButter

編集：<var>はJavaScriptでのみサポートされているようです。

Visual Studio 2012以降、<var>要素を使用してこのドキュメントを追加できます。

これに関するMicrosoftのドキュメントは次のとおりです。
https://msdn.Microsoft.com/en-us/library/hh542722（v = vs.110）.aspx

0
user2587659

クラスやメソッドの要約を書くのと同じように、変数でも機能します。

0
Pedryk

このような XMLドキュメント コメントを、メンバー（メソッド、プロパティなど）内ではなく、任意のclassメンバーに追加できます。

0
abatishchev