¿Qué son las etiquetas de documentación de C #?
En C #, las etiquetas de documentación le permiten producir resultados similares a MSDN. ¿Qué es una lista de etiquetas permitidas para usar dentro del área de comentarios /// (triple barra) sobre las clases, métodos y propiedades?
Consulte Excelente documentación sobre las diversas etiquetas de documentación XML de C #. (Vaya al final para ver las etiquetas)
Si escribe esto justo encima de un método o clase, intellisense debería solicitarle una lista de etiquetas disponibles:
/// <
Aquí hay una lista:
- resumen
- param
- devoluciones
- ejemplo
- código
- ver
- ver también
- lista
- valor
- archivo
- derechos de autor
Aquí hay un ejemplo:
<file>
<copyright> (c) Extreme Designers Inc. 2008. </copyright>
<datecreated> 2008-09-15 </datecreated>
<summary>
Aquí está mi resumen
</summary>
<remarks>
<para> Se puede usar <see cref = "TextReader" /> de las siguientes maneras: </para>
<list type = "number">
<item> primer elemento </item>
<item> segundo elemento </item>
</list>
</remarks>
<ejemplo>
<code>
System.Console.WriteLine ("Hola, Mundo" );
</code>
</example>
<param name = "aParam"> Mi primer parámetro </param>
<devuelve> un objeto que representa un resumen </returns>
</file>
Artículo de MSDN de 2002 que detalla todas las etiquetas y cuándo usarlas:
GhostDoc ayuda creando un comentario de código auxiliar para su método/clase.
Vea el excelente artículo de MSDN aquí como su primera parada.
Mire dentro de los documentos para Sandcastle . Este es el nuevo estándar de documentación para .NET.