C# xml /// Comentários, onde a tag aparece?

Question

Atualmente, sou um estudante de programação e, obviamente, minha pergunta é simples, mas não consegui encontrar a resposta online. Então aqui está:

Em xml /// comentários em c#, onde o <returns> tag aparecer, eu sei que tudo contido no <summary> A tag aparece no IntelliSense quando você passa o mouse sobre sua chamada de método, mas não a tag Returns.

Então, onde faz o <returns> tag entra?

Obrigado.

Answer 1

Quando você vê o método em vista >> navegador de objeto

Por exemplo, você verá algo assim:

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 você gerar documentação da API a partir dos comentários, ela aparecerá no Valor de retorno seção, Como visto aqui, logo antes do Comentários seção.

Answer 3

Quando você escolhe criar um arquivo de documentação XML na compilação, tudo o que está contido nos comentários da documentação XML é copiado nesse arquivo. Programas como Castelo de Areia Em seguida, pode criar documentação HTML semelhante ao MSDN a partir disso.

Não aparece no próprio Intellisense do Visual Studio, até onde eu sei. Mas isso não é desculpa para não escrever algo lá :-). Ctrl+q de Resharper, por exemplo faz mostre.

Answer 4

As outras seções (basicamente qualquer coisa de exceção summary) não aparecerá no Intellisense. Eles devem aparecer apenas na documentação gerada a partir do XML, usando uma ferramenta como Castelo de Areia.