visual - summary c#




¿Cuáles son las etiquetas de documentación C#? (5)

Aquí hay una lista:

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

Aquí hay un ejemplo:

<file>
<copyright>(c) Extreme Designers Inc. 2008.</copyright>
<author>Kevin Driedger</author>
<datecreated>2008-09-15</datecreated>
<summary>
Here's my summary
</summary>
<remarks>
<para>The <see cref="TextReader"/> can be used in the following ways:</para>
<list type="number">
<item>first item</item>
<item>second item</item>
</list>
</remarks>
<example>
<code>
System.Console.WriteLine("Hello, World");
</code>
</example>
<param name="aParam">My first param</param>
<returns>an object that represents a summary</returns>
</file>

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?



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


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

/// <

GhostDoc te ayuda creando un comentario de código auxiliar para tu método / clase.





documentation