Ich weiß, dass das vielleicht eine grundlegende Frage ist, aber ich kann einfach nicht die Antwort irgendwo finden.
Ich habe eine Klasse wie diese
%Vor%Dann habe ich einen Code, der die obige Klasse verwendet, die ich kommentieren möchte. Ich möchte etwas tun können wie:
%Vor%Aber ich kann die spitze Klammer im Kommentar nicht verwenden, weil sie denkt, dass es ein Tag ist und wenn die Hilfe erscheint, hat sie nur einen Fehler über kein End-Tag für.
Wie zeige ich generische Klassen in Kommentaren in Visual Studio an.
Sie müssen XML-Entitäten verwenden (eine Art von Escape-Sequenzen): & amp; lt; für & lt; und & amp; gt; für & gt ;. Intellisense zeigt & lt; as und & gt; richtig.
BEARBEITEN : Hier ist eine Cheat-Sheet-Liste aller XML-Entitäten:
%Vor% Das Problem mit & amp; 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 & lt; Zusammenfassung & gt; etc, Dokumentation auszugeben, dann ist es nicht streng korrekt, aber es funktioniert für mich.
Tags und Links visual-studio comments