c# - オブジェクトの概要の改行

Question

ご挨拶

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

/// <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たが、うまくいきません。これを行う方法はありますか？

score 213 · Accepted Answer

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

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

score 45 · Accepted Answer

これは古いスレッドである可能性がありますが、 VisualStudio2019を使用しているときに回答を探していました。段落と行の区切りが欲しかった。以下は私にとってうまく機能します：

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

score 33 · Accepted Answer

はい：

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

score 9 · Accepted Answer

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

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

次のようになります：

Main comment
Line 1
Line 2

よろしくお願いします！

score 4 · Accepted Answer

パラタグを合法的に追加することはできますが、これにより、実際には新しい行ごとに新しい段落が作成され、行の間隔がずれて表示されます。
私は個人的に段落の周りに1つの段落を追加し、次にbrブレークしたい行の終わりにタグを付けます。これにより、適切な行間隔が維持されます。

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

score 2 · Accepted Answer

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

ただし、 タグの後にスペースがある場合は、次の行に余分なスペースが入ることに注意してください。したがって、各行に同じ量のスペースを配置する必要があるため、すべての行が直線になります。

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

score 2 · Accepted Answer

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

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

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

Summary  
Main summary line.

Your secondary summary

score 1 · Accepted Answer

Swashbuckle（Swagger Web API統合ライブラリ）を使用している場合は、<para></para>に置き換える必要があり 、使用することもできます。

だから次の

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

になります

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

この問題はすでにここで説明されています： Swashbuckleのドキュメントに改行を追加するにはどうすればよいですか？-特別な設定、domaindrivendevのコメント、 https：//github.com/domaindrivendev/Swashbuckle/issues/258を使用- 使用法について。

c# - オブジェクトの概要の改行

8 に答える 8

Related

Reference