21

がある

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

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

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

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

編集：わかりました、クラス内のuコメントがあれば通常どおり機能しますが、メソッドまたは関数の外にあることがわかりました。

メソッド内で文書化/コメントする方法もありますか？

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";
    }
}
4

6 に答える 6

16

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

于 2011-10-31T17:13:33.993 に答える
13

Visual Studio2010では完全に正常に機能しているようです。メインフォームクラス内にコメントを含むプライベートフィールドとしてリストを定義しました。

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

ここに画像の説明を入力してください

于 2011-10-31T13:08:37.497 に答える
6

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

于 2011-10-31T13:12:34.873 に答える
0

クラスの要約を書くのと同じ方法で、メソッドは変数に対して機能します。

于 2011-10-31T13:03:26.047 に答える
0

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

于 2011-10-31T13:03:28.497 に答える
0

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

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

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

于 2016-04-26T21:34:27.117 に答える