NewLine no resumo do objeto


98

saudações

Ao definir um resumo para uma propriedade / campo / método etc. é possível ter uma nova linha nele?

/// <summary>
/// This is line 1
/// This is line 2
/// </summary>
public bool TestLine { get; set; }

Quando eu defino isso, mostra como ao passar o mouse:

bool TestLine
This is line 1 This is line 2

Mas quero que seja mostrado como:

bool TestLine
This is line 1 
This is line 2

Já tentei usar, \nmas não deu certo. Existe alguma maneira de fazer isso?

Respostas:


186

Você quer usar algo assim

/// <summary> 
/// Your Main comment 
/// <para>This is line 1</para> 
/// <para>This is line 2</para> 
/// </summary> 
public bool TestLine { get; set; }

1
@YetAnotherUser, que tal uma linha em branco?
Behzad

1
@Behzad tente usar <para>&nbsp;</para>.
YetAnotherUser

15
Odeio essas falas extras :(
Jan Macháček

10
No IDE do Visual Studio 2017, a "solução" acima realmente exibe uma LINHA EM BRANCO solitária entre as linhas 1 e 2 (ou seja, uma nova linha após a linha 1 seguida por uma linha em branco e depois pela linha 2) - não é o mesmo a nova linha, conforme solicitado pelo OP. Isso é um bug no IDE do VS 2017 - ou todos que votaram não veem que essa resposta não produz o que o OP mostra como a saída desejada?
Jazimov

Esse é um novo parágrafo, não uma nova linha. Parece-me que a sintaxe da documentação é um tanto limitadora.
GrizzlyMcBear

33

Sim:

/// <summary> 
/// Main comment 
/// <para>Line 1</para> 
/// <para>Line 2</para> 
/// </summary> 
public bool TestLine { get; set; }

12

Este pode ser um tópico antigo, mas eu estava procurando por um anwser enquanto usava o Visual Studio 2019 . Eu queria quebras de parágrafo e linhas. O seguinte funciona bem para mim:

/// <summary>
/// <para>parameter name="guidType" options:</para>
/// <br>0 = SequentialAsString</br>
/// <br>1 = SequentialAsBinary</br>
/// <br>2 = SequentialAtEnd</br>
/// </summary>

Produz o seguinte:

parameter name="guidType" options:

0 = SequentialAsString
1 = SequentialAsBinary
2 = SequentialAtEnd

4
Para VS2019 em diante, esta resposta é tecnicamente mais correta do que a resposta aceita.
Riaan Walters de

Você também pode usar <br /> apenas no final da linha no VS2019. Essas soluções produzem uma quebra de linha real e não um novo parágrafo com uma linha vazia! Obrigado
Phillip S

5

Você pode usar <para />para adicionar uma nova linha ao resumo:

/// <summary> 
/// Main comment<para />
/// Line 1<para />
/// Line 2<para />
/// </summary>
public bool TestLine { get; set; }

Parece:

Main comment
Line 1
Line 2

Cumprimentos!


2

Estou apenas adicionando isso para qualquer pessoa que use o Xamarin Studio como eu. Descobri que nenhuma das soluções acima funcionam para mim, mas esta funcionou:

/// <summary>
/// Main summarry line.
/// <para></para>
/// <para></para>
/// Your secondary summary
/// </summary>

Isso dá a seguinte saída:

Summary  
Main summary line.

Your secondary summary

1

Se você estiver usando o Swashbuckle (biblioteca de integração do Swagger Web API), ele <para></para>deve ser substituído por <p></p>e <br/>também pode ser usado.

então o seguinte

    /// <para>
    ///     Flag1, Flag2
    ///     - bool flags, optional.
    /// </para>

torna-se

    /// <p>
    ///     Flag1, Flag2<br/>
    ///     - bool flags, optional.
    /// </p>

O problema já está descrito aqui: Como adicionar quebra de linha à documentação do Swashbuckle? - usando uma configuração especial, o comentário do domaindrivendev, https://github.com/domaindrivendev/Swashbuckle/issues/258 - no <br/>uso.


0

Você pode adicionar tags para legitimamente, mas isso na verdade cria um novo parágrafo para cada nova linha e o espaçamento entre linhas aparece desligado.
Eu pessoalmente adiciono 1 parágrafo ao redor do parágrafo e, em seguida, brmarcações no final das linhas nas quais eu queria uma pausa, o que preserva um espaçamento de linha decente:

/// <summary> 
/// <para>Main comment<br /> 
/// Line 1<br />
/// Line 2</para> 
/// </summary>
public bool TestLine { get; set; }

3
Isso não funciona e não há nada errado com o espaçamento com <para>. Qual versão do VS / .Net você está usando?
Dani

2
As tags HTML serão ignoradas por summary, mesmo se estiverem dentro da paratag.
Lazaro Fernandes Lima Suleiman

-7

Eu sugeriria usar essa formatação se você quiser várias linhas no resumo sem complicar. Funcionará se você usar a tag <br /> após cada linha. (usá-lo em qualquer lugar dentro do texto criará uma nova linha onde a tag também está.)

Porém, observe que se você tiver um espaço após a tag <br />, receberá um espaço extra na próxima linha. Então você quer ter a mesma quantidade de espaço em cada linha, então cada linha será em linha reta.

/// <summary>
/// This is line 1<br />
/// This is line 2<br />
/// This is line 3<br />
/// </summary>
public bool TestLine { get; set; }

3
Primeira coisa que tentei antes de procurar uma solução porque não funcionou!
Philippe

Funciona para mim também. Votos positivos
AlexWei
Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.