Bagaimana cara menambahkan jeda baris dalam dokumentasi C # .NET

196

Ini seharusnya lebih mudah ...

Saya ingin menambahkan jeda baris "berkode" ke dokumentasi XML dalam kode saya

/// <summary>
/// Get a human-readable variant of the SQL WHERE statement of the search element. &lt;br/&gt;
/// Rather than return SQL, this method returns a string with icon-tokens, which 
/// could be used to represent the search in a condensed pictogram format.
/// </summary>

Seperti yang Anda lihat, saya menemukan beberapa jawaban yang menunjukkan penambahan tanda kurung <dan>. Menariknya, jeda baris yang bagus tidak membuat jeda baris di sembulan Intellisense.

Saya menemukan ini menjengkelkan ...

Ada saran?

c# .net xml-documentation Tinkerer_CardTracker
sumber
3
Dimungkinkan untuk menggunakan <br/> untuk membuat jeda baris pada Visual studio 2019. Rujuk jawabannya di sini .
23bl

Jawaban:

314

Anda dapat menggunakan <para />tag untuk menghasilkan jeda paragraf atau Anda dapat membungkus teks dalam <para></para>tag sebagai cara untuk mengelompokkan teks dan menambahkan baris kosong setelahnya, tetapi tidak ada yang setara dengan <br />atau semacamnya. (Yang menurut posting forum MS lama ini adalah dengan desain.) Anda bisa mendapatkan daftar tag yang tersedia di artikel dokumentasi ini dari MS. Mendokumentasikan kode Anda

Contoh (berdasarkan sampel OP asli): 

/// <summary>
/// <para>Get a human-readable variant of the SQL WHERE statement of the search element.</para>
/// Rather than return SQL, this method returns a string with icon-tokens, which 
/// could be used to represent the search in a condensed pictogram format.
/// </summary>
pstrjds
sumber
5
Aha! Sekarang sedang memasak! Terima kasih! Ini telah mengganggu saya untuk waktu yang lama sekarang ... Saya melihat opsi para tercantum, tetapi menganggap itu adalah jalan pintas "paramater".
Tinkerer_CardTracker
2
Tidak bekerja untuk saya. Menggunakan VB.NET pada VS 2010, dicoba dengan dan tanpa opsi parameter berwarna Powertools, <para>tag diabaikan, dan semuanya dicampur menjadi satu baris di Intellisense. Menemukan pertanyaan ini, di mana Hans menjelaskan masalahnya: stackoverflow.com/questions/7070737/… .
Neolisk
1
Pastikan Anda menambahkan tag </para> penutup juga =)
link64
85
Hal buruk tentang ini adalah bahwa ia benar-benar menambahkan satu baris kosong, bukan hanya baris baru.
Membagi
6
Jadi, adakah yang menemukan cara untuk benar-benar menyisipkan satu baris, bukan dua?
75

Ini adalah penggunaan saya, seperti <br/>, itu berfungsi :)

/// <summary>
/// Value: 0/1/2
/// <para/>0 foo,
/// <para/>1 bar,
/// <para/>2 other
/// </summary>
IlPADI
sumber
8
Mengapa jawaban ini tidak dipilih? Ini bekerja, dan tampaknya menjadi solusi yang jauh lebih baik daripada menggunakan <para>&#160;</para>, <para>&nbsp;</para>atau karakter yang tidak terlihat ...
Dinei
Ini berfungsi untuk baris baru, tetapi tidak akan menyisipkan garis kosong antara hal-hal seperti yang dilakukan opsi lain.
Yushatak
15
Dalam versi terbaru VS <para/>sepertinya menambah baris kosong, bukan hanya satu baris.
Dinei
2
@IlPADlI, +1 untuk contoh penggunaan. Dikonfirmasi bekerja pada Pembaruan Utama VS 2012 5.
Dennis T --Reinstate Monica--
9
VS 2017: baris kosong ditambahkan, bukan hanya baris ... microsoft tentu senang mengatakan apa yang ingin kami lakukan ...
Assimilater
39

Pada Visual Studio 2019, gunakan <br/> untuk baris baru dalam komentar.

Contoh:

/// <summary>
/// This is a comment.<br/>
/// This is another comment <br/>
/// This is a long comment so i want it to continue <br/> on another line.
/// </summary>

masukkan deskripsi gambar di sini

Perhatikan bahwa tidak ada garis tambahan ditambahkan ketika kita menggunakan <br/>bukannya <para>.

23bl
sumber
4
Masih berguna karena pertanyaan ini adalah hasil google teratas untuk cara menambahkan jeda baris dalam dokumentasi C #.
Dan
27

Tambahkan <para>tag dengan karakter khusus di dalamnya, karakter 255, atau karakter tidak terlihat .

/// <summary>
/// Some text
/// <para>   </para>
/// More text
/// </summary>
/// <param name="str">Some string</param>
public void SomeMethod(string str) { }

Ini akan bekerja seperti ini:

masukkan deskripsi gambar di sini

Joel
sumber
8
Ini membantu, namun &nbsp;tidak berhasil, sebagai gantinya gunakan/// <para>&#160;</para>
Robert H
1
Saya pribadi menyimpan /// <para> </para>catatan tempel. Maka tinggal salin dan tempel! (Dan itu berhasil - setidaknya untuk saya)
Joel
2
Saya tidak tahu mengapa, tetapi salin tempel /// <para> </para>tidak bekerja sama sekali. /// <para>&#160;</para>bekerja!
wenqiang
8
Daripada menggunakan <para>tag di antara blok teks, Anda harus menggunakan <para>tag di sekitar semua paragraf kecuali yang pertama dalam <summary>elemen. Untuk <typeparam>, <param>, <value>, <exception>, dan <returns>unsur-unsur, gunakan mereka di sekitar semua paragraf jika Anda memiliki lebih dari satu (opsional jika Anda hanya memiliki satu untuk elemen ini). Untuk semua elemen blok lainnya (termasuk <note>di dalam elemen blok lain), gunakan <para>tag di sekitar semua paragraf, bahkan jika Anda hanya memilikinya.
Sam Harwell
1
Sumber: Saya menulis ini, termasuk sebagian besar gaya presentasi: openstacknetsdk.org/docs-master/html/…
Sam Harwell
3

<br></br>dan <br />tampaknya tidak berhasil, dan kadang-kadang ini bukan soal membuat <para>kalimat terpisah , melainkan keinginan untuk memiliki garis kosong untuk pemisahan yang memprihatinkan. Saya menyebutkan ini di sini karena pertanyaan ini tampaknya menjadi pertanyaan bagi banyak pertanyaan tertutup seperti ini.

Satu-satunya hal yang saya temukan berhasil adalah 

<para>&#160;</para>

Sebagai contoh

/// <summary>
///     <para>
///         "This sentence shows up when the type is hovered"
///     </para>
///     <para>&#160;</para>
///     <para>int PrimaryKey</para>
///     <para>&#160;</para>
///     <para>virtual Relation Relation</para>
/// </summary>

Hasil dalam

"This sentence shows up when the type is hovered"

int PrimaryKey

virtual Relation Relation
Travis J
sumber