NewLine w podsumowaniu obiektów

99

Pozdrowienia

Podczas ustawiania podsumowania dla właściwości / pola / metody itp. Czy jest możliwe umieszczenie w nim nowej linii?

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

Kiedy to ustawię, pokazuje się jak po najechaniu myszą:

bool TestLine
This is line 1 This is line 2

Ale chcę, żeby to było wyświetlane jako:

bool TestLine
This is line 1 
This is line 2

Próbowałem użyć, \nale to nie działa. Czy jest jakiś sposób, aby to zrobić?

Theun Arbeider
źródło

Odpowiedzi:

188

Chcesz użyć czegoś takiego

/// <summary> 
/// Your Main comment 
/// <para>This is line 1</para> 
/// <para>This is line 2</para> 
/// </summary> 
public bool TestLine { get; set; }
YetAnotherUser
źródło
1
@YetAnotherUser, a co z pustą linią?
Behzad
1
@Behzad spróbuj użyć <para>&nbsp;</para>.
YetAnotherUser
15
Nienawidzę tych dodatkowych linii :(
Jan Macháček
10
W środowisku IDE programu Visual Studio 2017 powyższe „rozwiązanie” w rzeczywistości wyświetla samotną PUSTĄ LINIĘ między wierszem 1 a wierszem 2 (czyli nowy wiersz po wierszu 1, po którym następuje pusty wiersz, a następnie wiersz 2) - to nie jest to samo a nowa linia, zgodnie z żądaniem PO. Czy to błąd w IDE VS 2017 - czy też każdy, kto głosował wyżej, nie widzi, że ta odpowiedź nie daje tego, co OP pokazuje jako pożądane wyjście?
Jazimov
To nowy akapit, a nie nowa linia. Wydaje mi się, że składnia dokumentacji jest nieco ograniczona.
Grizzly McBear,
33

Tak:

/// <summary> 
/// Main comment 
/// <para>Line 1</para> 
/// <para>Line 2</para> 
/// </summary> 
public bool TestLine { get; set; }
Mitch Wheat
źródło
14

To może być stary wątek, ale szukałem anwser podczas korzystania z Visual Studio 2019 . Chciałem łamać akapity i linie. U mnie dobrze działa:

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

Produkuje:

parameter name="guidType" options:

0 = SequentialAsString
1 = SequentialAsBinary
2 = SequentialAtEnd
Thomas Cayne
źródło
4
Dla VS2019 i nowszych, ta odpowiedź jest technicznie bardziej poprawna niż zaakceptowana odpowiedź.
Riaan Walters
Możesz także po prostu użyć <br /> na końcu linii w VS2019. Te rozwiązania tworzą rzeczywisty podział wiersza, a nie nowy akapit z pustą linią! Dzięki
Phillip S
5

Możesz użyć, <para />aby dodać nową linię w podsumowaniu:

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

Wygląda jak:

Main comment
Line 1
Line 2

Z poważaniem!

fdelgado
źródło
2

Po prostu dodam to dla każdego, kto używa Xamarin Studio, tak jak ja. Okazało się, że żadne z powyższych rozwiązań nie działa dla mnie, ale to zadziałało:

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

Daje to następujący wynik:

Summary  
Main summary line.

Your secondary summary
głowa w kodach
źródło
1

Jeśli używasz Swashbuckle (biblioteki integracji interfejsu API sieci Web Swagger), <para></para>należy go zastąpić <p></p>i <br/>również można go użyć.

więc następujące

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

staje się

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

Problem jest już opisany tutaj: Jak dodać podział wiersza do dokumentacji Swashbuckle? - przy użyciu specjalnej konfiguracji, komentarz domaindrivendev, https://github.com/domaindrivendev/Swashbuckle/issues/258 - o <br/>użyciu.

Dmitrij Karpenko
źródło
0

Możesz legalnie dodawać znaczniki para, ale w rzeczywistości tworzy to nowy akapit dla każdego nowego wiersza, a odstępy między wierszami wydają się być wyłączone.
Osobiście dodaję 1 akapit wokół akapitu, a następnie brtagi na końcu wierszy, w których chciałem zrobić przerwę, co pozwala zachować przyzwoity odstęp między wierszami:

/// <summary> 
/// <para>Main comment<br /> 
/// Line 1<br />
/// Line 2</para> 
/// </summary>
public bool TestLine { get; set; }
PDizzle
źródło
3
To nie działa i nie ma nic złego w odstępach z <para>. Jakiej wersji VS / .Net używasz?
Dani,
2
Tagi HTML będą ignorowane przez summary, nawet jeśli znajdują się wewnątrz paratagu.
Lazaro Fernandes Lima Suleiman
-7

Sugerowałbym użycie tego formatowania, jeśli chcesz, aby podsumowanie zawierało wiele wierszy, nie komplikując go. Będzie działać, jeśli użyjesz tagu <br /> po każdym wierszu. (użycie go w dowolnym miejscu w tekście spowoduje utworzenie nowego wiersza, w którym również znajduje się tag).

Pamiętaj jednak, że jeśli masz spację po tagu <br />, dostaniesz dodatkową spację o jedną w następnej linii. Więc chcesz mieć taką samą ilość miejsca w każdej linii, aby każdy wiersz był w linii prostej.

/// <summary>
/// This is line 1<br />
/// This is line 2<br />
/// This is line 3<br />
/// </summary>
public bool TestLine { get; set; }
Jonathan
źródło
3
Pierwszą rzeczą, którą wypróbowałem przed szukaniem rozwiązania, ponieważ to nie działa!
Philippe