NewLine ในการสรุปวัตถุ


102

ทักทาย

เมื่อตั้งค่าสรุปสำหรับคุณสมบัติ / ฟิลด์ / วิธี ฯลฯ .. เป็นไปได้ไหมที่จะมีการขึ้นบรรทัดใหม่

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

เมื่อฉันตั้งค่านี้จะแสดงเป็นเมื่อวางเมาส์เหนือ:

bool TestLine
This is line 1 This is line 2

แต่ฉันต้องการให้แสดงเป็น:

bool TestLine
This is line 1 
This is line 2

ฉันได้ลองใช้\nแล้วแต่ไม่ได้ผล มีวิธีใดบ้างที่จะทำให้เสร็จได้?

คำตอบ:


192

คุณต้องการใช้บางสิ่งเช่นนี้

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

1
@YetAnotherUser แล้วบรรทัดว่างล่ะ
Behzad

1
@Behzad ลองใช้<para>&nbsp;</para>.
YetAnotherUser

11
ใน Visual Studio 2017 IDE "โซลูชัน" ข้างต้นจะแสดง BLANK LINE เดี่ยวระหว่างบรรทัดที่ 1 และบรรทัดที่ 2 (นั่นคือขึ้นบรรทัดใหม่หลังจากบรรทัดที่ 1 ตามด้วยบรรทัดว่างจากนั้นบรรทัดที่ 2) ซึ่งไม่เหมือนกับ บรรทัดใหม่ตามที่ OP ร้องขอ นั่นเป็นข้อผิดพลาดใน VS 2017 IDE - หรือทุกคนที่โหวตไม่เห็นว่าคำตอบนี้ไม่ได้ให้สิ่งที่ OP แสดงเป็นผลลัพธ์ที่ต้องการ?
Jazimov

1
นั่นคือย่อหน้าใหม่ไม่ใช่ขึ้นบรรทัดใหม่ สำหรับฉันแล้วรู้สึกว่าไวยากรณ์ของเอกสารประกอบค่อนข้าง จำกัด
GrizzlyMcBear


15

นี้อาจจะเป็นด้ายเก่า แต่ฉันถูกค้นหาสำหรับ Anwser ในขณะที่ใช้Visual Studio 2019 ฉันต้องการแบ่งย่อหน้าและบรรทัด สิ่งต่อไปนี้ใช้ได้ดีสำหรับฉัน:

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

ผลิตสิ่งต่อไปนี้:

parameter name="guidType" options:

0 = SequentialAsString
1 = SequentialAsBinary
2 = SequentialAtEnd

4
สำหรับ VS2019 เป็นต้นไปคำตอบนี้ถูกต้องในทางเทคนิคมากกว่าคำตอบที่ยอมรับ
Riaan Walters

คุณยังสามารถใช้ <br /> ที่ท้ายบรรทัดใน VS2019 ได้อีกด้วย โซลูชันเหล่านี้ทำให้เกิดการแบ่งบรรทัดจริงไม่ใช่ย่อหน้าใหม่ด้วยบรรทัดว่าง! ขอบคุณ
Phillip S

8

คุณสามารถใช้<para />เพื่อเพิ่มบรรทัดใหม่ภายในสรุป:

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

ดูเหมือน:

Main comment
Line 1
Line 2

ขอแสดงความนับถืออย่างสูง!


2

ฉันแค่เพิ่มสิ่งนี้สำหรับทุกคนที่ใช้ Xamarin Studio เหมือนฉัน ฉันพบว่าวิธีแก้ปัญหาข้างต้นไม่ได้ผลสำหรับฉัน แต่วิธีนี้ทำได้:

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

สิ่งนี้ให้ผลลัพธ์ต่อไปนี้:

Summary  
Main summary line.

Your secondary summary

1

หากคุณใช้ Swashbuckle (ไลบรารีการรวม Swagger Web API) <para></para>ควรแทนที่ด้วย<p></p>และ<br/>สามารถใช้งานได้

ดังต่อไปนี้

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

กลายเป็น

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

ปัญหานี้ได้อธิบายไว้แล้วที่นี่: จะเพิ่มตัวแบ่งบรรทัดลงในเอกสาร Swashbuckle ได้อย่างไร - ใช้การกำหนดค่าพิเศษความคิดเห็นของ domaindrivendev https://github.com/domaindrivendev/Swashbuckle/issues/258 - ใน<br/>การใช้งาน


0

คุณสามารถเพิ่มแท็กพาราได้อย่างถูกต้อง แต่สิ่งนี้จะสร้างย่อหน้าใหม่สำหรับแต่ละบรรทัดใหม่และระยะห่างระหว่างบรรทัดจะปรากฏขึ้น
ฉันเองเพิ่ม 1 para รอบ ๆ ย่อหน้าจากนั้นbrแท็กที่ท้ายบรรทัดฉันต้องการหยุดพักซึ่งจะรักษาระยะห่างระหว่างบรรทัดที่เหมาะสม:

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

3
วิธีนี้ใช้ไม่ได้ผลและไม่มีอะไรเกี่ยวกับการเว้นระยะห่างกับ <para> คุณใช้ VS / .Net เวอร์ชันใดอยู่
Dani

2
แท็ก HTML จะถูกละเว้นsummaryแม้ว่าจะอยู่ภายในparaแท็กก็ตาม
Lazaro Fernandes Lima Suleiman

-6

ฉันขอแนะนำให้ใช้การจัดรูปแบบนี้หากคุณต้องการหลายบรรทัดในการสรุปโดยไม่ทำให้ซับซ้อน จะใช้งานได้ถ้าคุณใช้แท็ก <br /> หลังแต่ละบรรทัด (การใช้ที่ใดก็ได้ภายในข้อความจะสร้างบรรทัดใหม่ที่มีแท็กด้วย)

แม้ว่าโปรดทราบว่าหากคุณมีช่องว่างหลังแท็ก <br /> คุณจะได้รับช่องว่างเพิ่มเติมในบรรทัดถัดไป คุณจึงต้องการมีพื้นที่เท่ากันในแต่ละบรรทัดดังนั้นทุกแถวจึงเป็นเส้นตรง

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

3
สิ่งแรกที่ฉันพยายามก่อนที่จะมองหาวิธีแก้ปัญหาเพราะไม่ได้ผล!
Philippe

ดูเหมือนจะใช้งานได้ในขณะนี้ การใช้ Visual Studio 2019
Hammy
โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.