オブジェクトの概要の改行


97

ご挨拶

プロパティ/フィールド/メソッドなどの概要を設定するときに、改行を含めることはできますか?

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

これを設定すると、マウスオーバーのように表示されます。

bool TestLine
This is line 1 This is line 2

しかし、私はそれを次のように見せたいです:

bool TestLine
This is line 1 
This is line 2

使ってみましたがうまくいき\nません。これを行う方法はありますか?

回答:


185

このようなものを使いたい

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

1
@YetAnotherUser、空白行はどうですか?
Behzad 2013年

1
@Behzadを使ってみてください<para>&nbsp;</para>
YetAnotherUser 2013年

15
私はそれらの余分な行を嫌います:(
JanMacháčekJun

10
Visual Studio 2017 IDEでは、上記の「解決策」は実際には1行目と2行目の間に空白行を1つ表示します(つまり、1行目の後に改行が続き、その後に空白行が続き、2行目)。これは同じではありません。 OPが要求したとおりの新しい行。それはVS 2017 IDEのバグですか?または、賛成票を投じたすべての人が、OPが目的の出力として示すものを生成しないことに気づきませんか?
Jazimov 2018

これは新しい段落ではなく、新しい行です。ドキュメントの構文がいくらか制限されているように感じます。
GrizzlyMcBear

33

はい:

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

10

これは古いスレッドの可能性がありますが、Visual Studio 2019の使用中にアンサーを検索していました。段落と改行が欲しかった。以下は私にとってうまくいきます:

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

以下を生成します。

parameter name="guidType" options:

0 = SequentialAsString
1 = SequentialAsBinary
2 = SequentialAtEnd

4
VS2019以降では、この回答は技術的には受け入れられた回答よりも正確です。
Riaan Walters

VS2019の行末で<br />を使用することもできます。これらのソリューションは、実際の改行を生成し、空の行を含む新しい段落を生成しません!ありがとう
Phillip S

5

を使用<para />して、サマリー内に新しい行を追加できます。

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

次のようになります。

Main comment
Line 1
Line 2

宜しくお願いします!


2

私と同じようにXamarin Studioを使用している人のためにこれを追加しています。上記の解決策はどれもうまくいかないことがわかりましたが、これはうまくいきました:

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

これにより、次の出力が得られます。

Summary  
Main summary line.

Your secondary summary

1

あなたはSwashbuckle(闊歩ウェブAPI統合ライブラリ)を使用している場合<para></para>に置き換えるべき<p></p><br/>も使用することができます。

だから次

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

なる

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

問題はすでにここで説明されています: スワッシュバックルのドキュメントに改行を追加する方法?-特別な設定、domaindrivendevのコメント、 https://github.com/domaindrivendev/Swashbuckle/issues/258<br/>使用- 使用法。


0

正当にparaタグを追加できますが、これにより実際には新しい行ごとに新しい段落が作成され、行間が見えなくなります。
個人的に段落の周りに1パラを追加しbr、改行したい行の終わりにタグを付けます。これにより、適切な行間隔が維持されます。

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

3
これは機能せず、<para>による間隔については何も問題がありません。VS / .Netのどのバージョンを使用していますか?
ダニ

2
HTMLタグはsummaryparaタグの内側にある場合でも無視されます。
ラサロフェルナンデスリマスレイマン

-7

複雑にすることなく要約に複数の行が必要な場合は、このフォーマットを使用することをお勧めします。各行の後に<br />タグ使用すると機能します(テキスト内の任意の場所で使用すると、タグもある場所に新しい行が作成されます。)

ただし、<br />タグの後にスペースがある場合は、次の行にスペースが1つ追加されることに注意してください。したがって、各行に同じ量のスペースが必要なので、すべての行は直線になります。

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

3
それが機能しないため、解決策を探す前に最初に試したこと!
フィリップ

わたしにはできる!
CWKSC

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