Feedback

C# - XML-Doku, see-Tag und Generika

Veröffentlicht von am 06.10.2013
(0 Bewertungen)
Dieses Snippet ist weniger Code als ein Teil einer XML-Dokumentation.

Wenn man sich auf andere Typen bezieht, dann sollte man den s.g. see-Tag benutzen. Dieser hat den Vorteil, das er speziel formatiert werden kann und vom Umbenennungstool von Visual Studio betroffen ist.

Nun gibt es aber auch Generische Typen wie Beispielsweise List<T>. Nun kann man aber nicht einfach List<T> oder List(Of T) oder List`1 schreiben. Der Compiler gibt eine Warnung aus, das der Typ nicht gefunden wurde. Dieses Snippet zeigt die richtige Syntax.

Leider steht dazu auch gar nichts in dem dazu gehöhrigen MSDN-Artikel:
http://msdn.microsoft.com/DE-DE/library/vstudio/acd0tfbe.aspx

Hinweis: Auch andere Tags wie bspws. seealso benutzen das gleiche Format.
/// <summary>
/// <see cref="System.Collections.Generic.List{T}"/>
/// </summary>
Abgelegt unter XML, Dokumentation, see, cref, Generic.

Kommentare zum Snippet

 

Logge dich ein, um hier zu kommentieren!