¿Cuáles son los C# documentación de las etiquetas?[cerrado]
-
09-06-2019 - |
Pregunta
En C# documentación de etiquetas le permiten producir una salida similar a MSDN.¿Qué es una lista de posibles etiquetas para su uso en el interior de la /// (triple slash) área de comentarios por encima de las clases, métodos y propiedades?
Solución
Echa un vistazo Gran documentación sobre los distintos C# documentación XML las etiquetas. (Ir a la parte inferior para ver las etiquetas)
Otros consejos
Si el tipo que esta justo encima de un método o clase, intellisense debe solicitar una lista de etiquetas disponibles:
/// <
He aquí una lista:
- resumen
- param
- devuelve
- ejemplo
- código
- ver
- seealso
- lista
- valor
- archivo
- los derechos de autor
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>
Artículo de MSDN de 2002, detallando todas las etiquetas y cuando hacer uso de ellos:
GhostDoc ayuda mediante la creación de una punta de comentario para el método o clase.
Véase el excelente artículo de MSDN aquí como su primera parada.
Mira dentro de la documentación para el Castillos de arena.Esta es la nueva documentación estándar para .NET.