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
Du musst angemeldet sein, um einen Kommentar abzugeben.
Scheint zu funktionieren hervorragend in Visual Studio 2010. Ich definierte eine Liste als privates Feld mit einem Kommentar in meinem MainForm-Klasse.
Funktioniert Sie nicht für lokale Variablen definiert, die innerhalb von Funktionen wenn.
InformationsquelleAutor der Antwort gideon
Wie andere erwähnt haben, können Sie nicht bekommen, IntelliSense für lokale vars. Allerdings: Wenn deine Funktion ist so groß, dass ein "normaler" Kommentar ist nicht nah genug, um zu Lesen, in der Nähe der Ort, wo Sie mit dem Schlüsselwort var, dann Recht fix ist zu überarbeiten die Funktion -- brechen Sie in mehrere kleinere Methoden, mit weniger vars. Ich glaube nicht, dass dieses feature sollte existieren, als würde es nur dazu dienen, zu erleichtern, schriftlich zu große Funktionen.
InformationsquelleAutor der Antwort Craig Stuntz
Soweit ich weiß, hinzufügen von Kommentaren für die intellisense funktioniert nicht für lokale Variablen innerhalb von Funktionen. Wenn Sie waren, um Ihre lokalen Liste um eine Instanzvariable der Klasse, Sie wäre in der Lage, dies zu tun.
InformationsquelleAutor der Antwort ooPeanutButter
Die gleiche Art und Weise wie Sie schreiben-Zusammenfassung für Klassen und Methoden für Variablen.
InformationsquelleAutor der Antwort Pedryk
Können Sie hinzufügen, wie XML-Dokumentation Kommentare zu irgendeiner Klasse Mitglied, nicht in einem Element (Methode, Eigenschaft, etc.).
InformationsquelleAutor der Antwort abatishchev
Edit: es sieht aus wie <var> wird nur unterstützt, für die JavaScript.
Als von Visual Studio 2012 können Sie fügen Sie diese Dokumentation über die <var> - element.
Hier ist in der Dokumentation von Microsoft:
https://msdn.microsoft.com/en-us/library/hh542722(v=vs. 110).aspx
InformationsquelleAutor der Antwort user2587659