C# XML /// Comentarios, ¿dónde aparece <returns></returns> etiqueta?

Question

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

En XML /// comentarios en C#, donde aparece la etiqueta <returns>, sé que todo lo que contiene la etiqueta <summary> aparece en intellisense cuando pasa el mouse sobre la llamada a su método, pero no la etiqueta de devoluciones

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

Gracias.

Answer 1

Cuando vea el método de ver >> Examinador de objetos

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 sección Retorno as seen here, justo antes de las Observaciones sección.

Answer 3

Cuando elige compilar un archivo de documentación XML en la compilación, todo lo que está contenido en los comentarios de la documentación XML se copia en ese archivo. Los programas como Sandcastle pueden construir documentación HTML similar a la de MSDN a partir de eso.

No aparece en IntelliSense de Visual Studio, hasta donde yo sé. Pero eso no es excusa para no escribir algo allí :-). ReSharper's Ctrl + Q por ejemplo hace muéstrelo.

Answer 4

Las otras secciones (básicamente cualquier excepción summary) no aparecerán en intellisense. Solo están destinados a aparecer en la documentación generada a partir del XML, utilizando una herramienta como Sandcastle.