Nesne özetinde NewLine

Selamlar

Bir özellik / alan / yöntem vb. İçin bir özet ayarlarken, içinde yeni bir satır olması mümkün müdür?

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

Bunu ayarladığımda farenin üzerinde olduğu gibi görünüyor:

bool TestLine
This is line 1 This is line 2

Ama şu şekilde görünmesini istiyorum:

bool TestLine
This is line 1 
This is line 2

Kullanmayı denedim \nama bu işe yaramıyor. Bunu halletmenin bir yolu var mı?

Bunun gibi bir şey kullanmak istiyorsun

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

Evet:

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

Bu eski bir iş parçacığı olabilir ancak Visual Studio 2019 kullanırken bir yanıtlayıcı arıyordum . Paragraf ve satır sonları istedim. Aşağıdakiler benim için iyi çalışıyor:

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

Aşağıdakileri üretir:

parameter name="guidType" options:

0 = SequentialAsString
1 = SequentialAsBinary
2 = SequentialAtEnd

Özete <para />yeni bir satır eklemek için kullanabilirsiniz :

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

Görünüşe göre:

Main comment
Line 1
Line 2

Saygılarımla!

Bunu benim gibi Xamarin Studio kullanan herkes için ekliyorum. Yukarıdaki çözümlerden hiçbirinin benim için işe yaramadığını buldum, ancak bu işe yaradı:

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

Bu, aşağıdaki çıktıyı verir:

Summary  
Main summary line.

Your secondary summary

Swashbuckle (Swagger Web API entegrasyon kitaplığı) kullanıyorsanız, o zaman <para></para>ile değiştirilmelidir <p></p>ve <br/>kullanılabilir.

yani aşağıdaki

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

olur

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

Sorun burada zaten açıklanmıştır: Swashbuckle belgelerine satır sonu nasıl eklenir? - özel bir yapılandırma kullanarak, domaindrivendev'in yorumu, https://github.com/domaindrivendev/Swashbuckle/issues/258 - <br/>kullanım hakkında.

Yasal olarak para etiketleri ekleyebilirsiniz, ancak bu aslında her yeni satır için yeni bir paragraf oluşturur ve satır aralığı kapalı görünür.
Şahsen paragrafın etrafına 1 para ekliyorum ve ardından brara vermek istediğim satırların sonuna etiketler ekliyorum , bu da düzgün satır aralığını koruyor:

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

Özette karmaşık hale getirmeden birden fazla satır istiyorsanız, bu biçimlendirmeyi kullanmanızı öneririm. Her satırdan sonra <br /> etiketini kullanırsanız işe yarayacaktır . (metnin içinde herhangi bir yerde kullanmak etiketin de bulunduğu yerde yeni bir satır oluşturacaktır.)

Yine de, <br /> etiketinden sonra bir boşluk varsa, sonraki satırda fazladan bir boşluk alacağınızı unutmayın. Yani her satırda aynı miktarda boşluğa sahip olmak istiyorsunuz, bu nedenle her satırda düz bir çizgi olacak.

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