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


196

これはもっと簡単になるはずです...

コード内の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ポップアップで改行を作成しません。

私はこれがいらいらします...

助言がありますか?


3
Visual Studio 2019以降、改行を作成するために<br/>を使用することが可能ですここで回答を参照してください。
23bl

回答:


314

<para />タグを使用して段落の区切りを作成したり<para></para>、テキストをグループ化してその後ろに空白行を追加する方法としてテキストをタグでラップしたりできますが、それに相当する<br />ものはありません。(これは、この古い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>

5
ああ!今料理してた!ありがとう!これは長い間私を悩ませてきました...私はリストされたparaオプションを見ましたが、それが「パラメーター」ショートカットであると想定しました。
Tinkerer_CardTracker

2
うまくいきませんでした。VS 2010でVB.NETを使用して、Powertoolsのカラー化されたパラメーターオプションの有無にかかわらず、<para>タグは無視され、すべてがIntellisenseで1行に混在しています。Hansが問題を説明したこの質問が見つかりました:stackoverflow.com/questions/7070737/…
Neolisk 2013年

1
必ず終了</ para>タグも追加するようにしてください=)
link64

85
これの悪い点は、実際には新しい行だけでなく、空白行が1行追加されることです。
2016年

6
では、実際に2行ではなく1行を挿入する方法を見つけた人はいますか?

75

これは私の使用法であり、<br/>動作しています:)

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

8
なぜこの回答は反対投票されているのですか?それは動作し、使用するよりもはるかに優れたソリューションであるように思わ<para>&#160;</para><para>&nbsp;</para>または目に見えない文字...
Dinei

これは改行で機能しますが、他のオプションのように、間に空白行を挿入しません。
ユシャタク2016

15
最近のバージョンのVS <para/>では、改行だけでなく空白行が追加されるようです。
Dinei 2017年

2
@IlPADlI、使用例は+1。確認したVS 2012究極のアップデート5.に取り組ん
デニス・T --Reinstate Monica--

9
VS 2017:空白行がない単に改行...マイクロソフト必ず愛は、私たちが何をしたいのかを告げて、追加...
Assimilater

39

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>

ここに画像の説明を入力してください

<br/>代わりにを使用すると、余分な行が追加されないことに注意してください<para>


4
この質問は、C#のドキュメントに改行を追加する方法に関するGoogleの上位の結果であるため、依然として役に立ちます。
Dan

27

追加<para>その中の特別な文字、255文字、またはでタグを目に見えない文字

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

次のように機能します。

ここに画像の説明を入力してください


8
これは役に立ちますが、&nbsp;機能しません。代わりに使用してください/// <para>&#160;</para>
Robert H

1
個人的に/// <para> </para>付箋をつけています。コピーして貼り付けるだけです!(そして、それは機能します-少なくとも私にとっては)
Joel

2
理由はわかりませんが、コピーペースト/// <para> </para>がまったく機能しません。 /// <para>&#160;</para>動作します!
wenqiang 2014年

8
<para>テキストのブロック間でタグを使用するのではなく、要素の最初の<para>段落を除くすべての段落囲むタグを使用する必要があり<summary>ます。以下のために<typeparam><param><value><exception>、および<returns>要素、周りそれらを使用するすべてのあなたが複数ある場合は(あなただけのこれらの要素のための1つを持っている場合は、オプションの)段落。他のすべてのブロック要素(<note>別のブロック要素の内部を含む)については、<para>段落が1つしかない場合でも、すべての段落をタグで囲みます。
サムハーウェル、2014

1
出典:私は、プレゼンテーションのスタイルのほとんどを含めて、これを執筆:openstacknetsdk.org/docs-master/html/...
サム・ハーウェル

3

<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
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.