web-dev-qa-db-ja.com

C＃.NETドキュメントで改行を追加する方法

これは簡単なはずです...

コード内のXMLドキュメントに「コード化された」改行を追加したい

/// <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>

ご覧のとおり、<と>の括弧の追加を示すいくつかの答えを見つけました。興味深いことに、良い 'ol <br />改行は、Intellisenseポップアップで改行を作成しません。

これは迷惑だと思います...

助言がありますか？

c#.netxml-documentation
175
Tinkerer_CardTracker

<para />タグを使用して段落区切りを作成するか、テキストをグループ化し、その後に空白行を追加する方法として<para></para>タグでテキストを折り返すことができますが、<br />またはそのようなもの。 （ this によると、古いMSフォーラムの投稿は仕様によるものです。）このドキュメント記事で利用可能なタグのリストをMSから取得できます。 コードの文書化

例（元の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>
290
pstrjds

これは<br/>のような私の使用法です、その動作:)

/// <summary>
/// Value: 0/1/2
/// <para/>0 foo,
/// <para/>1 bar,
/// <para/>2 other
/// </summary>
63
IlPADlI

特殊文字、255文字、または 不可視文字 を含む<para>タグを追加します。

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

次のように機能します。

enter image description here

25
Joel

<br></br>と<br />は機能しないようです。また、懸念の分離のために空白行を作成したいという願望ほど、<para>文を分離することではない場合があります。この質問は、この性質の多くの非公開の質問の親のようだからです。

私が仕事を見つけたのは

<para>&#160;</para>

例えば

/// <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>

結果

"This sentence shows up when the type is hovered"

int PrimaryKey

virtual Relation Relation
3
Travis J

Visual Studio 2019以降、<br/>を使用したコメントは、新しい行でコメントを作成するためにサポートされます。

例えば：

 /// <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>

次の画像で、上記の例を実際に見ることができます。

enter image description here

<br/>タグを使用する場合とは対照的に、<para>タグを使用する場合、追加の行は追加されないことに注意してください。

0
23bl