web-dev-qa-db-de.com

Wie schreibe ich Kommentare/Dokumentation für Variablen/Felder/Listen in VS 2010?

Es gibt

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

dokumentation für Klassen oder Methoden. Aber wie schreibt man das für einfache Variablen oder Listen?

Ich benutze Visual Studio 2010 und wenn ich mit der Maus über eine Liste, eine Eigenschaft oder was auch immer schwebe, möchte ich eine Art Zusammenfassung sehen (in diesem kleinen Tooltip), die ich zu dieser bestimmten Sache geschrieben habe.

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

edit: ok, wir haben herausgefunden, dass es wie gewohnt funktioniert solange du in deiner Klasse kommentierst aber AUSSERHALB einer Methode oder einer Funktion !!

Gibt es auch eine Möglichkeit, innerhalb einer Methode zu dokumentieren/zu kommentieren?

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

Scheint in Visual Studio 2010 einwandfrei zu funktionieren. Ich habe eine Liste als privates Feld mit einem Kommentar in meiner MainForm-Klasse definiert.

Sie funktionieren jedoch nicht für lokale Variablen, die in Funktionen definiert sind.

enter image description here

10
gideon

Wie bereits erwähnt, können Sie IntelliSense für lokale Vars nicht erhalten. Allerdings: Wenn Ihre Funktion so groß ist, dass ein "normaler" Kommentar nicht nah genug ist, um an der Stelle gelesen zu werden, an der Sie die var verwenden, dann ist die richtige Korrektur die Funktion umzugestalten - sie aufzuteilen mehrere, kleinere Methoden mit weniger Vars. Ich denke nicht, dass diese Funktion sollte vorhanden ist, da sie nur dazu dient, das Schreiben übermäßig großer Funktionen zu erleichtern.

12
Craig Stuntz

Soweit ich weiß, funktioniert das Hinzufügen von Kommentaren für Intellisense nicht für lokale Variablen, die in Funktionen deklariert sind. Wenn Sie Ihre lokale Liste zu einer Instanzvariablen der Klasse machen würden, könnten Sie dies tun.

6
ooPeanutButter

Bearbeiten: Es sieht so aus, als ob <var> nur für JavaScript unterstützt wird.

Ab Visual Studio 2012 können Sie diese Dokumentation mit dem Element <var> hinzufügen.

Hier ist die Dokumentation von Microsoft dazu:
https://msdn.Microsoft.com/en-us/library/hh542722(v=vs.110).aspx

0
user2587659

Die gleiche Art und Weise, wie Sie eine Zusammenfassung für Klassen und Methoden schreiben, funktioniert für Variablen.

0
Pedryk

Sie können eine solche XML-Dokumentation Kommentare zu jedem class member hinzufügen, das sich nicht in einem Member befindet (Methode, Eigenschaft usw.).

0
abatishchev