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. <br/>
/// 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?
c#
.net
xml-documentation
Tinkerer_CardTracker
źródło
źródło
Odpowiedzi:
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 koduPrzykład (na podstawie oryginalnej próbki OP):
źródło
<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/… .To jest moje użycie, jak
<br/>
działa :)źródło
<para> </para>
,<para> </para>
albo niewidoczny znak ...<para/>
wydaje się dodawać pustą linię, a nie tylko podział linii.Począwszy od Visual Studio 2019, używaj
<br/>
do nowych wierszy w komentarzach.Przykład:
Zauważ, że nie dodajemy żadnej dodatkowej linii, gdy używamy
<br/>
zamiast<para>
.źródło
Dodaj
<para>
tag ze specjalnym znakiem, 255 znaków lub niewidoczny znak .Będzie to działać w ten sposób:
źródło
nie działa, zamiast tego użyj/// <para> </para>
/// <para> </para>
karteczkę. Następnie wystarczy skopiować i wkleić! (I to działa - przynajmniej dla mnie)/// <para> </para>
ogóle nie działa./// <para> </para>
Pracuje!<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.<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
Na przykład
Prowadzi do
źródło