2009-01-12 3 views
8

Ich weiß, dass dies vielleicht eine grundlegende Frage, aber ich kann einfach nicht die Antwort irgendwo finden.Generische Klasse z. B. Tabelle <String> in XML-Kommentare in Visual Studio

Ich habe eine Klasse wie diese

Table<T> 
{} 

dann habe ich einige Code, den die oben genannte Klasse verwendet, die ich mag würde kommentieren Ich möchte in der Lage sein, etwas zu tun:

/// <summary> 
/// blah blah blah Table<String> 
/// </summary> 

Aber ich kann nicht die spitze Klammer im Kommentar verwenden, da es denkt, dass es ein Tag ist und wenn die Hilfe erscheint, hat es nur einen Fehler über kein End-Tag für.

Wie zeige ich generische Klassen in Kommentaren in Visual Studio.

Antwort

22

Sie müssen XML-Entitäten verwenden (Art von Escape-Sequenzen): & lt; für < und & gt; für >. Intellisense zeigt < as und > korrekt an.

EDIT: Hier ist ein Spickzettel Auflistung aller XML-Entitäten:

&lt; for < 
&gt; for > 
&amp; for & 
&quot; for " 
&apos; for ' 
2

versuchen Sie mit einem & lt; anstelle von <

0

Das Problem mit & lt; ist, dass es hässlich aussieht und in Kommentaren schwer zu lesen ist. Ich benutze folgendes: GenericThing≪T,U≫. Das sind nicht zwei spitze Klammern, sondern ein einzelnes Zeichen. Es sieht in Intellisense und beim Lesen der Kommentare gut aus. Wenn Sie < Zusammenfassung> etc verwenden, um Dokumentation auszugeben, dann ist es nicht streng korrekt, aber es funktioniert für mich.

Verwandte Themen