วิธีเพิ่มตัวแบ่งบรรทัดในเอกสารประกอบ C # .NET


197

ควรจะง่ายกว่านี้ ...

ฉันต้องการเพิ่มตัวแบ่งบรรทัด "รหัส" ลงในเอกสาร XML ในรหัสของฉัน

/// <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>

อย่างที่คุณเห็นฉันพบคำตอบบางอย่างที่แสดงการเพิ่ม <และ> วงเล็บเหลี่ยม ที่น่าสนใจการแบ่งบรรทัด 'ol <br /> ที่ดีไม่ได้สร้างการแบ่งบรรทัดในป๊อปอัพ Intellisense

ฉันพบว่ามันน่ารำคาญ ...

ข้อเสนอแนะใด ๆ


3
มันเป็นไปได้ที่จะใช้สำหรับการสร้าง <br/> แบ่งบรรทัด ณ สตูดิโอ Visual 2019 อ้างถึงคำตอบที่นี่
23 bl

คำตอบ:


317

คุณสามารถใช้<para />แท็กเพื่อสร้างตัวแบ่งย่อหน้าหรือคุณสามารถตัดข้อความใน<para></para>แท็กเป็นวิธีการจัดกลุ่มข้อความและเพิ่มบรรทัดว่างหลังจากนั้น แต่ไม่มีอะไรเทียบเท่า<br />หรืออะไรทำนองนั้น (ซึ่งเป็นไปตามโพสต์ฟอรัม MS เก่านี้คือการออกแบบ) คุณสามารถรับรายการของแท็กที่มีอยู่ในบทความเอกสารนี้จาก MS เอกสารรหัสของคุณ

ตัวอย่าง (ขึ้นอยู่กับตัวอย่าง OP ต้นฉบับ):

/// <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>

5
Aha! ตอนนี้กำลังทำอาหาร! ขอบคุณ! สิ่งนี้ทำให้ฉันรำคาญมาเป็นเวลานานแล้ว ... ฉันเห็นตัวเลือก para อยู่ในรายการ แต่คิดว่ามันเป็นทางลัด "พารามิเตอร์"
Tinkerer_CardTracker

2
ไม่ได้ผลสำหรับฉัน การใช้ VB.NET บน VS 2010 พยายามด้วยตัวเลือกพารามิเตอร์ colorized ของ Powertools <para>แท็กจะถูกละเว้นและทุกอย่างจะถูกรวมเป็นบรรทัดเดียวใน Intellisense พบคำถามนี้ที่ฮันส์อธิบายปัญหา: stackoverflow.com/questions/7070737/...
Neolisk

1
ตรวจสอบให้แน่ใจว่าคุณเพิ่มแท็กปิด </para> เช่นกัน =)
link64

87
สิ่งที่ไม่ดีเกี่ยวกับเรื่องนี้คือมันเพิ่มหนึ่งบรรทัดว่างทั้งหมดแทนที่จะเป็นแค่บรรทัดใหม่
Devid

6
ดังนั้นมีใครพบวิธีที่จะแทรกหนึ่งบรรทัดจริง ๆ แทนที่จะเป็นสองบรรทัด?

75

นี่คือการใช้งานของฉันเช่น<br/>มันใช้งานได้ :)

/// <summary>
/// Value: 0/1/2
/// <para/>0 foo,
/// <para/>1 bar,
/// <para/>2 other
/// </summary>

8
ทำไมคำตอบนี้จึงลดลง? มันทำงานได้และดูเหมือนจะเป็นทางออกที่ดีกว่าการใช้<para>&#160;</para>, <para>&nbsp;</para>หรือตัวอักษรที่มองไม่เห็น ...
Dinei

สิ่งนี้ใช้ได้กับการขึ้นบรรทัดใหม่ แต่จะไม่แทรกบรรทัดว่างระหว่างสิ่งต่าง ๆ ที่ตัวเลือกอื่นทำ
Yushatak

16
ใน VS เวอร์ชันล่าสุด<para/>ดูเหมือนว่าจะเพิ่มบรรทัดว่างไม่ใช่แค่ตัวแบ่งบรรทัด
Dinei

2
@IlPADlI, +1 สำหรับตัวอย่างการใช้งาน ยืนยันการทำงานกับ VS 2012 Ultimate Update 5
Dennis T

9
VS 2017: เพิ่มบรรทัดว่างไม่ใช่เพียงแค่ตัวแบ่งบรรทัด ... ไมโครซอฟท์แน่ใจว่าชอบบอกเราว่าเราต้องการทำอะไร ...
Assimilater

41

ตั้งแต่ Visual Studio 2019 ใช้<br/>สำหรับบรรทัดใหม่ในความคิดเห็น

ตัวอย่าง:

/// <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>

ป้อนคำอธิบายรูปภาพที่นี่

ขอให้สังเกตว่าไม่มีเส้นพิเศษที่เพิ่มเมื่อเราใช้แทน<br/><para>


4
ยังมีประโยชน์เพราะคำถามนี้เป็นผลลัพธ์ยอดนิยมของ google สำหรับวิธีเพิ่มตัวแบ่งบรรทัดในเอกสารประกอบ C #
ด่าน

27

เพิ่ม<para>แท็กที่มีถ่านพิเศษในนั้น 255 ถ่านหรือถ่านที่มองไม่เห็น

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

มันจะทำงานเช่นนี้:

ป้อนคำอธิบายรูปภาพที่นี่


8
สิ่งนี้มีประโยชน์ แต่&nbsp;ใช้งานไม่ได้แทนที่จะใช้/// <para>&#160;</para>
Robert H

1
ฉันเก็บไว้/// <para> </para>ในใจเป็นส่วนตัว จากนั้นเป็นเพียงการคัดลอกและวาง! (และมันก็ใช้ได้ - อย่างน้อยสำหรับฉัน)
Joel

2
ฉันไม่รู้ว่าทำไม แต่การคัดลอกวาง/// <para> </para>ไม่ทำงานเลย /// <para>&#160;</para>ทำงาน!
wenqiang

8
แทนที่จะใช้<para>แท็กระหว่างบล็อคข้อความคุณควรใช้<para>แท็กที่อยู่รอบ ๆ ย่อหน้าทั้งหมดยกเว้นส่วนแรกใน<summary>องค์ประกอบ สำหรับ<typeparam>, <param>, <value>, <exception>และ<returns>องค์ประกอบที่ใช้พวกเขาทั่วทุกย่อหน้าถ้าคุณมีมากกว่าหนึ่ง (ไม่จำเป็นถ้าคุณมีเพียงหนึ่งสำหรับองค์ประกอบเหล่านี้) สำหรับองค์ประกอบบล็อกอื่น ๆ ทั้งหมด (รวมถึง<note>ด้านในขององค์ประกอบบล็อกอื่น) ให้ใช้<para>แท็กรอบย่อหน้าทั้งหมดแม้ว่าคุณจะมีเพียงหนึ่ง
Sam Harwell

1
แหล่งที่มา: ฉันเขียนสิ่งนี้รวมถึงสไตล์การนำเสนอส่วนใหญ่: openstacknetsdk.org/docs-master/html/ …
Sam Harwell

3

<br></br>และ<br />ดูเหมือนจะไม่ทำงานและบางครั้งมันก็ไม่เกี่ยวกับการทำให้<para>ประโยคแยกจากกันมากเท่าที่ความปรารถนาที่จะมีบรรทัดว่างสำหรับการแยกความกังวล ฉันกำลังพูดถึงเรื่องนี้ที่นี่เพราะคำถามนี้ดูเหมือนจะเป็นคำถามหลักสำหรับผู้ปกครองในคำถามนี้

สิ่งเดียวที่ฉันพบในการทำงานคือ

<para>&#160;</para>

ตัวอย่างเช่น

/// <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>

ผลลัพธ์ใน

"This sentence shows up when the type is hovered"

int PrimaryKey

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