Wie schreiben Sie Kommentare / Dokumentation für Variablen / Felder / Listen in VS 2010?

Es ist

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

Dokumentation für Klassen oder Methoden. Aber wie schreibt man dieses auch für einfache Variablen oder Listen?

Ich benutze Visual Studio 2010 und wenn ich den Mauszeiger über einige Liste, Eigenschaft oder was immer ich möchte, um zu sehen, eine Art Zusammenfassung (in diesem kleinen tooltip) ich habe geschrieben, dass bestimmte Sache.

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

edit: ok, wir haben heraus gefunden, dass es funktioniert wie gewohnt, so lange u Kommentar in der Klasse, aber AUßERHALB einer Methode oder Funktion!!

Irgendeiner Weise zu dokumentieren/kommentieren innerhalb einer Methode zu?

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

InformationsquelleAutor der Frage Gero | 2011-10-31

Schreibe einen Kommentar