Pregunta ¿Cuáles son las etiquetas de documentación C #? [cerrado]


En la documentación de C # las etiquetas le permiten producir resultados similares a MSDN. ¿Qué son una lista de etiquetas permitidas para usar dentro del área de comentarios /// (barra diagonal triple) por encima de clases, métodos y propiedades?


32
2017-09-15 19:29


origen


Respuestas:


Revisa Gran documentación sobre las diversas etiquetas de documentación XML de C #. (Ve a la parte inferior para ver las etiquetas)


6
2017-09-15 19:31



Si escribe esto justo encima de un método o clase, intellisense debería indicarle una lista de etiquetas disponibles:

/// <

12
2017-09-15 19:34



Aquí hay una lista:

  • resumen
  • param
  • devoluciones
  • ejemplo
  • código
  • ver
  • ver también
  • lista
  • valor
  • archivo
  • derechos de autor

Aquí hay un ejemplo:

<archivo>
<copyright> (c) Extreme Designers Inc. 2008. </ copyright>
<datecreated> 2008-09-15 </ datecreated>
<resumen>
Aquí está mi resumen
</ summary>
<observaciones>
<para> El <see cref = "TextReader" /> se puede usar de las siguientes maneras: </ para>
<list type = "number">
<item> primer elemento </ item>
<item> segundo artículo </ item>
</ list>
</ observaciones>
<ejemplo>
<code>
System.Console.WriteLine ("Hola, mundo");
</ code>
</ example>
<param name = "aParam"> Mi primer param </ param>
<returns> un objeto que representa un resumen </ returns>
</ archivo>

10
2017-09-15 19:47



Artículo de MSDN de 2002 que detalla todas las etiquetas y cuándo usarlas:

http://msdn.microsoft.com/en-us/magazine/cc302121.aspx


3
2017-09-15 19:31



GhostDoc ayuda al crear un comentario de código auxiliar para su método / clase.


3
2017-09-15 19:33



Vea el excelente artículo de MSDN aquí como tu primera parada.


2
2017-09-15 19:31



Mira dentro de los documentos para Castillo de arena. Este es el nuevo estándar de documentación para .NET.


1
2017-09-15 19:52