Pergunta

De acordo com Este artigo, é possível obter comentários XML multilinas - em vez de usar ///, usar /** */. Esta é a minha interpretação do que são comentários multilinas e o que eu quero ter acontecido:

/**
 * <summary>
 * this comment is on line 1 in the tooltip
 * this comment is on line 2 in the tooltip
 * </summary>
 */

No entanto, quando eu uso esse formulário, a dica de ferramenta que aparece quando eu mouse sobre o nome da minha classe no meu código é uma linha única, ou seja, parece exatamente como se eu tivesse escrito meu comentário assim:

/// <summary>
/// this comment is on line 1 in the tooltip
/// this comment is on line 2 in the tooltip
/// </summary>

Esse comportamento ainda é possível ainda no VS2008?

EDITAR

Gabe apontou que eu entendi mal o que significa "multilina", e eu realmente preciso usar <para> ou <br> para obter meu efeito pretendido. Eu fui em frente e usei <br> Porque eu quero controlar onde ocorrem as quebras da linha, ou seja,

/// <summary>
/// this comment is on line 1 in the tooltip<br/>
/// this comment is on line 2 in the tooltip<br/>
/// </summary>

Quando olho para a dica de ferramenta para esta aula no meu código, tudo ainda acaba em uma linha ... wth? Eu fiz algo errado aqui?

ATUALIZAR

Ok, fui em frente e tentei o <para> Tag em cada linha, e isso funciona. Não sei por que <br/> não.

/// <summary>
/// <para>this comment is on line 1 in the tooltip</para>
/// <para>this comment is on line 2 in the tooltip</para>
/// </summary>
Foi útil?

Solução

Parece que você está confuso sobre o que significa "várias linhas". Um comentário de linha única termina no final da linha de código-fonte e, se você quiser continuar esse comentário, deve colocar um "///"Na próxima linha. Um comentário de várias linhas começa com um"/*"E termina com um"*/"Portanto, pode terminar na mesma linha ou em várias linhas abaixo.

Ser "multi-line" não diz nada sobre como o texto dentro do comentário é exibido. Para colocar uma quebra de linha em um comentário XML, você deve inserir um <br/> ("Break") ou envolva a linha em um <para> ("Parágrafo") Tag.

Outras dicas

Tente isso

/// <summary>
/// this comment is on line 1 in the tooltip
/// <para>this comment is on line 2 in the tooltip</para>
/// </summary>

Adicionar <br/> para quebras de linha ou envolver os parágrafos em <para>...</para>. É como XML e HTML, a quebra da linha não passa de espaço em branco.

Licenciado em: CC-BY-SA com atribuição
Não afiliado a StackOverflow
scroll top