เมื่อต้องการแสดงข้อคิดเห็น XML บนบรรทัดใหม่

ใน Visual Studio คุณสามารถเขียนข้อคิดเห็นของเอกสาร XML บน C# และคุณสมบัติและวิธีการ VB.NET เมื่อคุณเขียนแล้วคุณจะสามารถดูคําอธิบายของคุณสมบัติหรือวิธีการเมื่อคุณเขียนเป็นโค้ดวางเคอร์เซอร์ของเมาส์และใช้เครื่องมือเช่น "Sandcastle"

อย่างไรก็ตามหากคุณเขียนมากเกินไปความสามารถในการอ่านจะลดลงดังนั้นโดยปกติคุณจะเขียนประมาณหนึ่งบรรทัด แต่ในบางกรณีคุณอาจต้องการแสดงในหลายบรรทัด

หากคุณแบ่งบรรทัดในความคิดเห็นตามปกติคุณจะคาดหวังว่าจะแสดงด้วยตัวแบ่งบรรทัดเมื่อคําอธิบายปรากฏขึ้น แต่เมื่อคุณลองจริงมันจะแสดงดังนี้

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

ผลการแสดงคําอธิบาย

ไม่มีตัวแบ่งบรรทัดในข้อความคําอธิบาย และเค้าโครงจะดูราวกับว่ามีช่องว่างอยู่ XML มีผลแตกต่างกันไปเกี่ยวกับวิธีการจัดการช่องว่างและตัวแบ่งบรรทัด และ Visual Studio ไม่ถือว่าตัวแบ่งบรรทัดปกติเป็นตัวแบ่งข้อความ

ดังนั้นหากคุณต้องการแบ่งข้อความคําอธิบายในบรรทัดวิธีการทําคือการใช้แท็ก "para" "para" ย่อมาจาก "ย่อหน้า" ล้อมรอบหน่วยที่คุณต้องการแบ่งเส้นเช่นนี้ในแท็ก para:

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

คําอธิบายจะแสดงพร้อมกับตัวแบ่งบรรทัดดังแสดงในรูป หากคุณใช้เครื่องมือสร้างเอกสารเครื่องมือนั้นจะปรากฏเป็นย่อหน้าที่มีตัวแบ่งบรรทัดด้วย