C# XML /// Commenti, dove viene visualizzato il tag <returns></returns>?

Question

Attualmente sono uno studente di programmazione e ovviamente la mia domanda è semplice, ma non sono stato in grado di trovare la risposta online. Ecco qui:

In XML /// commenti in C#, dove compare il tag <returns>, so che tutto ciò che è contenuto nel tag <summary> viene visualizzato in intellisense quando si passa il mouse sopra la chiamata al metodo, ma non il tag di ritorno.

Quindi da dove viene il tag <returns>?

Grazie.

Answer 1

Quando si vede il metodo in vista >> Visualizzatore oggetti

Per esempio si vedrà qualcosa di simile:

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

Se si genera documentazione API dai commenti, verrà visualizzato il valore sezione ritorno, as seen here, giusto prima che i Note sezione.

Answer 3

Quando si sceglie di creare un file di documentazione XML sulla compilazione, tutto ciò che è contenuto nei commenti della documentazione XML viene copiato in quel file. Programmi come Sandcastle possono quindi creare una documentazione HTML simile a MSDN.

Non viene visualizzato in IntelliSense di Visual Studio, per quanto ne so. Ma non è una scusa per non scrivere qualcosa lì :-). ReSharper's Ctrl + Q per esempio fa mostrarlo.

Answer 4

Le altre sezioni (in pratica qualsiasi eccezione summary) non verranno visualizzate in intellisense. Sono solo destinati a comparire nella documentazione generata dall'XML, utilizzando uno strumento come Sandcastle.