studio - ¿Cuáles son las etiquetas de documentación C#?

generar documentacion visual studio 2017

Question

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?

Answer 1

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>

Answer 2

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

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

Answer 3

Consulte la gran documentación en las diversas etiquetas de documentación XML de C #. (Ve a la parte inferior para ver las etiquetas)

Answer 4

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

Answer 5

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

/// <

Answer 6

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

Answer 7

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