En C#, las etiquetas de documentación le permiten generar 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?¿Qué son las etiquetas de documentación C#?
artículoSalida Great documentation on the various C# XML documentation tags. (ir a la parte inferior para ver las etiquetas)
MSDN de 2002 que detalla todas las etiquetas y cuándo usarlos:
Véase el excelente artículo de MSDN here como tu primera parada.
GhostDoc ayuda creando un código auxiliar para su método/clase.
Si escribe este justo por encima de un método o clase, IntelliSense debe le pedirá una lista de etiquetas disponibles:
/// <
¿Qué significan todas ellas en general? ¿Qué orden debería usar para especificarlos? ¿Cuáles serían los casos de uso apropiados para cada uno? ¿Qué es posible, pero desalentado en la práctica moderna del desarrollo? – Neolisk
He aquí una lista:
He aquí un ejemplo:
<file>
<copyright>(c) Extreme Designers Inc. 2008.</copyright>
<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>
No hay una etiqueta de autor para C# – Nap
¿Qué sucede si tengo una url que debo señalar para obtener más información? ¿Dónde pongo eso? –
@KevinDriedger - Te sugiero que edites la lista y elimines la etiqueta 'author'. Por un momento me alegré de verlo allí y luego me sentí decepcionado después de leer el comentario votado de Nap y verificarlo yo mismo con [el enlace provisto] (http://web.archive.org/web/20100118163744/http:// thoughtpad.net/alan-dean/cs-xml-documentation.html) [por David Mohundro] (https://stackoverflow.com/a/65989/978502) – yair
mirar dentro de la documentación para Sandcastle. Este es el nuevo estándar de documentación para .NET.
Por desgracia, el dominio ha expirado y este es un enlace roto. –
Bueno, eso huele mal: el caché de Google todavía lo tiene, pero ¿por cuánto tiempo, quién sabe? –
Supongo que es como JavaDocs cuando publica eso en una página web. Enlace más actualizado aquí: http://msdn.microsoft.com/en-us/library/b2s063f7.aspx – puretppc