Jak dodać podział wiersza w dokumentacji C # .NET

196

To powinno być łatwiejsze ...

Chcę dodać „zakodowany” podział wiersza do dokumentacji XML w moim kodzie

/// <summary>
/// Get a human-readable variant of the SQL WHERE statement of the search element. &lt;br/&gt;
/// Rather than return SQL, this method returns a string with icon-tokens, which 
/// could be used to represent the search in a condensed pictogram format.
/// </summary>

Jak widać, znalazłem kilka odpowiedzi, które wykazały dodanie nawiasów <i>. Co ciekawe, dobry podział wiersza „ol <br />” nie tworzy podziału wiersza w wyskakującym okienku Intellisense.

Uważam to za denerwujące ...

Jakieś sugestie?

Tinkerer_CardTracker
źródło
3
Można używać <br/> do tworzenia podziałów linii od Visual Studio 2019. Zobacz odpowiedź tutaj .
23bl

Odpowiedzi:

315

Możesz użyć <para />znacznika do utworzenia podziału akapitu lub zawinąć tekst w <para></para>znaczniki jako sposób grupowania tekstu i dodania pustego wiersza po nim, ale nie ma odpowiednika <br />ani nic podobnego. (Który zgodnie z tym starym postem na forum MS jest z założenia.) Listę dostępnych znaczników można znaleźć w tym artykule z dokumentacji od MS. Dokumentowanie twojego kodu

Przykład (na podstawie oryginalnej próbki OP):

/// <summary>
/// <para>Get a human-readable variant of the SQL WHERE statement of the search element.</para>
/// Rather than return SQL, this method returns a string with icon-tokens, which 
/// could be used to represent the search in a condensed pictogram format.
/// </summary>
pstrjds
źródło
5
Aha! Teraz gotowaliście! Dzięki! Od dłuższego czasu mnie to niepokoi ... Widziałem wymienioną opcję para, ale zakładałem, że jest to skrót „paramater”.
Tinkerer_CardTracker
2
Nie działało dla mnie. Korzystając z VB.NET na VS 2010, wypróbowany z opcją pokolorowanych parametrów Powertools i bez niej, <para>tagi są ignorowane i wszystko jest mieszane w jedną linię w Intellisense. Znalazłem to pytanie, w którym Hans wyjaśnił problem: stackoverflow.com/questions/7070737/… .
Neolisk,
1
Upewnij się, że dodajesz również tag zamykający </para> =)
link64
86
Złą rzeczą jest to, że w rzeczywistości dodaje jedną pustą linię zamiast tylko nowej linii.
Devid
6
Czy ktoś znalazł sposób na wstawienie jednej linii zamiast dwóch?
75

To jest moje użycie, jak <br/>działa :)

/// <summary>
/// Value: 0/1/2
/// <para/>0 foo,
/// <para/>1 bar,
/// <para/>2 other
/// </summary>
IlPADlI
źródło
8
Dlaczego ta odpowiedź została odrzucona? To działa, i wydaje się być o wiele lepszym rozwiązaniem niż używanie <para>&#160;</para>, <para>&nbsp;</para>albo niewidoczny znak ...
Dinei
Działa to dla nowych linii, ale nie wstawia pustej linii między rzeczami, jak inne opcje.
Yushatak,
15
W najnowszych wersjach VS <para/>wydaje się dodawać pustą linię, a nie tylko podział linii.
Dinei
2
@IlPADlI, +1 na przykład użycia. Potwierdzono pracę nad ostateczną aktualizacją VS 2012 Ultimate 5.
Dennis T - Przywróć Monikę--
9
VS 2017: dodano pustą linię, a nie tylko podział linii ... Microsoft z pewnością uwielbia mówić nam, co chcemy robić ...
Assimilater,
39

Począwszy od Visual Studio 2019, używaj <br/>do nowych wierszy w komentarzach.

Przykład:

/// <summary>
/// This is a comment.<br/>
/// This is another comment <br/>
/// This is a long comment so i want it to continue <br/> on another line.
/// </summary>

wprowadź opis zdjęcia tutaj

Zauważ, że nie dodajemy żadnej dodatkowej linii, gdy używamy <br/>zamiast <para>.

23bl
źródło
4
Nadal przydatne, ponieważ to pytanie jest najlepszym wynikiem Google, jak dodać podział wiersza w dokumentacji C #.
Dan
27

Dodaj <para>tag ze specjalnym znakiem, 255 znaków lub niewidoczny znak .

/// <summary>
/// Some text
/// <para>   </para>
/// More text
/// </summary>
/// <param name="str">Some string</param>
public void SomeMethod(string str) { }

Będzie to działać w ten sposób:

wprowadź opis zdjęcia tutaj

Joel
źródło
8
Jest to pomocne, jednak &nbsp;nie działa, zamiast tego użyj/// <para>&#160;</para>
Robert H
1
Osobiście trzymam /// <para> </para>karteczkę. Następnie wystarczy skopiować i wkleić! (I to działa - przynajmniej dla mnie)
Joel
2
Nie wiem dlaczego, ale kopiowanie wklejenie w /// <para> </para>ogóle nie działa. /// <para>&#160;</para>Pracuje!
wenqiang
8
Zamiast używać <para>znacznika między blokami tekstu, należy używać <para>znacznika wokół wszystkich akapitów oprócz pierwszego w <summary>elemencie. Na <typeparam>, <param>, <value>, <exception>, i <returns>elementów, należy je wokół wszystkich punktach, jeśli masz więcej niż jeden (opcjonalnie, jeśli masz tylko jeden dla tych elementów). W przypadku wszystkich innych elementów bloku (w tym <note>wewnątrz innego elementu bloku) użyj <para>znaczników wokół wszystkich akapitów, nawet jeśli masz tylko jeden.
Sam Harwell
1
Źródło: Jestem autorem, w tym większości stylów prezentacji: openstacknetsdk.org/docs-master/html/...
Sam Harwell
3

<br></br>i <br />wydaje się, że nie działają, a czasami tak naprawdę nie chodzi o <para>rozdzielenie zdań, a raczej o chęć posiadania pustej linii do rozdzielenia obaw. Wspominam o tym tutaj, ponieważ pytanie to wydaje się odpowiadać wielu zamkniętym pytaniom tego rodzaju.

Jedyne, co znalazłem do pracy, to

<para>&#160;</para>

Na przykład

/// <summary>
///     <para>
///         "This sentence shows up when the type is hovered"
///     </para>
///     <para>&#160;</para>
///     <para>int PrimaryKey</para>
///     <para>&#160;</para>
///     <para>virtual Relation Relation</para>
/// </summary>

Prowadzi do

"This sentence shows up when the type is hovered"

int PrimaryKey

virtual Relation Relation
Travis J
źródło