Untuk menampilkan komentar XML pada baris baru

Di Visual Studio, Anda dapat menulis komentar dokumen XML di properti dan metode C# dan VB.NET. Setelah Anda menulisnya, Anda akan dapat melihat deskripsi properti atau metode ketika Anda menulisnya dalam kode, mengarahkan kursor mouse, dan menggunakan alat seperti "Sandcastle".

Namun, jika Anda menulis terlalu banyak, keterbacaannya akan berkurang, jadi biasanya Anda akan menulisnya dalam sekitar satu baris, tetapi dalam beberapa kasus Anda mungkin ingin menampilkannya pada beberapa baris.

Jika Anda memecah baris dalam komentar secara normal, Anda akan mengharapkannya ditampilkan dengan jeda baris ketika deskripsi ditampilkan, tetapi ketika Anda benar-benar mencobanya, itu akan ditampilkan sebagai berikut.

/// <summary>
/// これは
/// 普通に
/// 改行したもの
/// <summary>
public int Amount1 { get; set; }

Hasil tampilan penjelasan

Tidak ada hentian baris dalam teks deskripsi, dan tata letaknya terlihat seolah-olah berisi spasi. XML memiliki efek yang bervariasi pada bagaimana spasi putih dan hentian baris ditangani, dan Visual Studio tidak menganggap hentian baris normal sebagai hentian teks.

Jadi, jika Anda ingin memecah teks deskripsi pada satu baris, cara melakukannya adalah dengan menggunakan tag "para". "para" adalah singkatan dari "paragraf". Sertakan unit yang ingin Anda putuskan baris seperti ini dalam tag para:

/// <summary>
/// <para>paraを</para>
/// <para>使って</para>
/// <para>改行したもの</para>
/// </summary>
public int Amount2 { get; set; }

Deskripsi ditampilkan dengan hentian garis seperti yang ditunjukkan pada gambar. Jika Anda menggunakan alat pembuatan dokumen, itu juga akan muncul sebagai paragraf dengan hentian baris.