Wenn Sie XML-Dokumentation für C # -Methoden in Visual Studio erstellen (ich verwende 2010), erhalten Sie Intellisense-Unterstützung für die Erstellung der verschiedenen XML-Tags, z. B. see, paramref usw. Andererseits, wenn Sie hinzufügen Ein Cref-Attribut müssen Sie ein, was ich denke, ist gefaltetes Format, um Typen zu beschreiben. Dies ist am schlimmsten, wenn Sie eine Reihe von Generika haben.
Was ich suche ist wie folgt. Wenn Sie das cref-Attribut in einem see-Element festlegen, verfügen Sie über eine Intellisense-Liste mit Klassen, die Ihrer Eingabe entsprechen und dann die richtige Typbeschreibung ausgeben. Oder wenn Sie das cref-Attribut für ein paramref-Element festlegen, erhalten Sie die Liste der Parameter dieser Methode.
Kennt jemand eine Art Addon zu Visual Studio, um Intellisense für diese Cref-Attribute bereitzustellen?
Ich habe in letzter Zeit eine Menge XML-Dokumentation geschrieben, und ich denke, ReSharper bietet die Funktionalität, nach der Sie suchen, mit seinem Extended IntelliSense Codevervollständigung Funktion - ich benutze sie die ganze Zeit. Das Feature Schnelle Dokumentation ist beim Schreiben von Dokumentationen nicht zu übersehen - Mit ihr können Sie sehen, wie die XML-Dokumentation tatsächlich aussehen wird, wenn sie nach html / chm kompiliert wird, und sie wird in Echtzeit aktualisiert, wenn ich etwas in den Dokumenten mit dem Quick Documentation-Fenster ändere , Ich sehe es automatisch ändern - wirklich hilfreich für die Formatierung und so.
Wenn Sie Agent Smith zu dem Mix hinzufügen (der nur als Add funktioniert) (anscheinend auf ReSharper), kann es einige handliche Rechtschreibprüfung , XML-Kommentarvalidierung , Namenskonventionsprüfungen und ein einfaches einfaches Kommentar-Reflowing (wenn Sie besonders sind) hinzufügen über den Verbleib in einer bestimmten Anzahl von Zeichen / Zeilen) (wobei die ersten beiden wahrscheinlich die nützlichsten sind, da ReSharper die Möglichkeit bietet, Namenskonventionen zu erzwingen).
Hoffe das hilft!
Tags und Links c# visual-studio-2010 visual-studio intellisense xml-documentation