Cómo agregar elementos incluidos por < > a los comentarios de la documentación

Question

Estoy tratando de escribir los comentarios de la documentación, sin embargo, tengo un problema.

/// <summary> 
/// Inserts an element into the System.Collections.Generic.List<T> at the specified 
/// index. 
/// </summary> 

Cuando llego a la <T> Visual Studio piensa que estoy tratando de añadir otra etiqueta. ¿Cuál es la forma correcta de agregar comentarios como ese? (y si pudiera hacer clic en capaz en el texto de ayuda generado que sería una bonificación adicional)

Answer 1

C# documentación comentarios son XML, por lo que cambian su < y >-< y >.

Lo que más le conviene hacer es utilizar la etiqueta <see> para insertar un hipervínculo. En una etiqueta <see>, cambiar <T>-{T}:

/// <summary> 
/// Inserts an element into the <see cref="List{T}"/> at the specified 
/// index. 
/// </summary> 

(Tenga en cuenta que el atributo cref es sintaxis marcada por el compilador, a diferencia del texto ordinario.)

Answer 2

Como el comentario es xml puede usar las secuencias de escape apropiadas para xml:

/// Inserts an element into the System.Collections.Generic.List<T> at the specified 

Answer 3

escapan las entidades xml.

 
Change <T> into &lt;T&gt; 

Answer 4

Creo que esto sería de ayuda para usted: C# XML documentation comments FAQ.

Answer 5

Necesita utilizar los códigos de caracteres adecuados: &lt; y &gt;

Usted quiere surreound todo el System.Collections.Generic.List <T> en una etiqueta <see cref="..."/>.

realidad, tuve que usar las etiquetas mencionadas a escribir correctamente esta respuesta :)