C # XML /// Comentarios, ¿de dónde viene etiqueta aparece?

Question

Actualmente soy estudiante de programación, y, obviamente, mi pregunta es simple, pero no he sido capaz de encontrar la respuesta a la misma línea. Así que aquí está:

En XML /// comentarios en C #, donde hace el <returns> etiqueta espectáculo, sé que todo lo contenido en la etiqueta <summary> aparece en IntelliSense cuando se pasa el ratón por encima de su llamada a un método, pero no la etiqueta de devoluciones.

Entonces, ¿dónde la etiqueta <returns> entrar?

Gracias.

Answer 1

Cuando vea el método de ver >> Objeto navegador

Por ejemplo, verá algo como esto:

private int GetColumnIndex(Microsoft.Office.Interop.Excel.Worksheet worksheet, string columnName, int rowIndex, int startColumnIndex)
    Member of MyAddIn.CommandHandlers.CommandHandler

Summary:
Returns the column index with specified name and in specified row

Parameters:
worksheet: Target worksheet
columnName: Column name to find
rowIndex: Row index in which to search the column
startColumnIndex: Start index of the column

Returns:
The index of column if found, else returns 0

Answer 2

Si genera documentación de la API de los comentarios, se mostrará en el Valor de retorno sección, como se ve aquí , justo antes de la Observaciones sección.

Answer 3

Cuando se elige para construir un archivo de documentación XML en la compilación, entonces todo lo que está contenido en la documentación XML comentarios se copia encima en ese archivo. Programas como castillo de arena entonces se puede construir documentación HTML similar a la de MSDN de eso.

No se muestra en el propio IntelliSense de Visual Studio, por lo que yo sé. Pero eso no es excusa para no escribir algo allí :-). ReSharper Ctrl + Q, por ejemplo, hace mostrarla.

Answer 4

Las otras secciones (básicamente cualquier cosa excepción summary) no aparecerán en IntelliSense. Sólo están destinados a aparecer en la documentación generada a partir del XML, usando una herramienta como Sandcastle .