web-dev-qa-db-ja.com

オブジェクト概要の改行

あいさつ

プロパティ/フィールド/メソッドなどのサマリーを設定するとき、改行を入れることは可能ですか？

/// <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を使用してみましたが、うまくいきません。これを完了する方法はありますか？

c#newlinesummary
87
Theun Arbeider

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

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

はい：

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

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

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

次のようになります。

Main comment
Line 1
Line 2

宜しくお願いします！

3
fdelgado

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

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

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

Summary  
Main summary line.

Your secondary summary
2
head in the codes

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

だから次の

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

になる

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

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

1
Dmitry Karpenko

これは古いスレッドかもしれませんが、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
0
Thomas Cayne