NewLine dalam ringkasan objek


99

Salam pembuka

Saat menyetel ringkasan untuk properti / bidang / metode dll .. apakah mungkin memiliki baris baru di dalamnya?

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

Ketika saya mengatur ini, ini menunjukkan seperti di atas mouse:

bool TestLine
This is line 1 This is line 2

Tapi saya ingin itu ditampilkan sebagai:

bool TestLine
This is line 1 
This is line 2

Saya sudah mencoba menggunakan \ntetapi tidak berhasil. Apakah ada cara untuk menyelesaikannya?

Jawaban:


188

Anda ingin menggunakan sesuatu seperti ini

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

1
@YetAnotherUser, bagaimana dengan baris kosong?
Behzad

1
@Behzad coba gunakan <para>&nbsp;</para>.
YetAnotherUser

10
Dalam Visual Studio 2017 IDE, "solusi" di atas sebenarnya menampilkan satu baris KOSONG antara baris 1 dan baris 2 (yaitu, baris baru setelah baris 1 diikuti oleh baris kosong kemudian baris 2) - ini tidak sama a baris baru, seperti yang diminta OP. Apakah itu bug di VS 2017 IDE - atau apakah semua orang yang memilih-up tidak melihat bahwa jawaban ini tidak menghasilkan apa yang ditampilkan OP sebagai output yang diinginkan?
Jazimov

Itu paragraf baru, bukan baris baru. Bagi saya, sintaks dokumentasinya agak terbatas.
GrizzlyMcBear

33

Iya:

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

14

Ini mungkin utas lama tetapi saya sedang mencari jawaban saat menggunakan Visual Studio 2019 . Saya ingin paragraf dan baris istirahat. Berikut ini bekerja dengan baik untuk saya:

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

Menghasilkan yang berikut:

parameter name="guidType" options:

0 = SequentialAsString
1 = SequentialAsBinary
2 = SequentialAtEnd

4
Untuk VS2019 dan seterusnya, jawaban ini secara teknis lebih benar daripada jawaban yang diterima.
Riaan Walters

Anda juga dapat menggunakan <br /> tepat di akhir baris di VS2019. Solusi ini menghasilkan jeda baris yang sebenarnya dan bukan paragraf baru dengan baris kosong! Terima kasih
Phillip S

5

Anda dapat menggunakan <para />untuk menambahkan baris baru dalam ringkasan:

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

Seperti:

Main comment
Line 1
Line 2

Salam Hormat!


2

Saya hanya menambahkan ini untuk siapa saja yang menggunakan Xamarin Studio seperti saya. Saya menemukan bahwa tidak ada solusi di atas yang berfungsi untuk saya, tetapi yang ini berhasil:

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

Ini memberikan hasil sebagai berikut:

Summary  
Main summary line.

Your secondary summary

1

Jika Anda menggunakan Swashbuckle (perpustakaan integrasi API Web Swagger) maka <para></para>harus diganti dengan <p></p>dan <br/>juga dapat digunakan.

jadi berikut ini

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

menjadi

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

Masalahnya sudah dijelaskan di sini: Bagaimana cara menambahkan jeda baris ke dokumentasi Swashbuckle? - menggunakan konfigurasi khusus, komentar domaindrivendev, https://github.com/domaindrivendev/Swashbuckle/issues/258 - tentang <br/>penggunaan.


0

Anda dapat menambahkan tag para secara sah, tetapi ini sebenarnya membuat paragraf baru untuk setiap baris baru dan spasi baris tidak aktif.
Saya pribadi menambahkan 1 para di sekitar paragraf dan kemudian memberi brtag di akhir baris yang ingin saya hentikan, yang mempertahankan spasi baris yang layak:

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

3
Ini tidak berhasil, dan tidak ada yang salah tentang penspasian dengan <para>. Versi VS / .Net apa yang Anda gunakan?
Dani

2
Tag HTML akan diabaikan oleh summary, meskipun mereka berada di dalam paratag.
Lazaro Fernandes Lima Suleiman

-7

Saya akan menyarankan menggunakan pemformatan ini jika Anda ingin beberapa baris dalam ringkasan tanpa membuatnya rumit. Ini akan berfungsi jika Anda menggunakan tag <br /> setelah setiap baris. (menggunakannya di mana saja di dalam teks akan membuat baris baru di mana tag juga berada.)

Meskipun, perhatikan bahwa jika Anda memiliki spasi setelah tag <br />, Anda akan mendapatkan spasi ekstra di baris berikutnya. Jadi, Anda ingin memiliki jumlah ruang yang sama di setiap baris, jadi setiap baris akan berada di garis lurus.

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

3
Hal pertama yang saya coba sebelum mencari solusi karena itu tidak berhasil!
Philippe
Dengan menggunakan situs kami, Anda mengakui telah membaca dan memahami Kebijakan Cookie dan Kebijakan Privasi kami.
Licensed under cc by-sa 3.0 with attribution required.