method - remarks c#

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

Question

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

En XML /// comentarios en C #, dónde aparece la etiqueta <returns> , sé que todo lo que figura en la etiqueta <summary> aparece en intellisense cuando pasa el mouse por encima de su llamada a método, pero no la etiqueta de devoluciones.

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

Gracias.

Answer 1

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. Programas como Sandcastle pueden construir documentación HTML similar a MSDN a partir de eso.

No se muestra en la propia IntelliSense de Visual Studio, hasta donde yo sé. Pero eso no es excusa para no escribir algo allí :-). ReSharper''s Ctrl + Q, por ejemplo, lo muestra.

Answer 2

Cuando ve el método en 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 3

Las otras secciones (básicamente cualquier summary excepción) 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 .

Answer 4

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