C # .NET डॉक्यूमेंटेशन में लाइन ब्रेक कैसे जोड़ें

Question

यह waaaay आसान होना चाहिए ...

मैं अपने कोड में 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 /> लाइन ब्रेक इंटेलीसेन्स पॉपअप में लाइन ब्रेक नहीं बनाता है।

मुझे यह कष्टप्रद लगता है ...

कोई सुझाव?

Comments

विज़ुअल स्टूडियो 2019 के रूप में लाइन ब्रेक बनाने के लिए <br/> का उपयोग करना संभव है । यहां उत्तर देखें ।

— 23bl

Answer 1

आप <para />पैराग्राफ ब्रेक का उत्पादन करने के लिए एक टैग का उपयोग कर सकते हैं या आप पाठ <para></para>को समूह बनाने के लिए और इसके बाद रिक्त पंक्ति को जोड़ने के तरीके के रूप में टैग में पाठ लपेट सकते हैं , लेकिन इसके समान <br />या इसके समान कोई भी चीज़ नहीं है। (जो इस पुराने एमएस फोरम पोस्ट के अनुसार डिजाइन के अनुसार है।) आप एमएस से इस प्रलेखन लेख में उपलब्ध टैग की सूची प्राप्त कर सकते हैं। अपने कोड का दस्तावेजीकरण

उदाहरण (मूल ओपी नमूने पर आधारित):

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

Comments

अहा! अब खाना बना रहे थे! धन्यवाद! यह मुझे लंबे समय से परेशान कर रहा है ... मैंने सूचीबद्ध पैरा विकल्प को देखा, लेकिन यह मान लिया कि यह "पैरामैटर" शॉर्टकट था।

— Tinkerer_CardTracker

मेरे लिए काम नहीं किया। वीएस.नेट पर वीएस 2010 का उपयोग करते हुए, पावरटूल के रंगीन पैरामीटर विकल्प के साथ और उसके बिना कोशिश की गई, <para>टैग्स को नजरअंदाज कर दिया गया और इंटेलीजेंस में सब कुछ एक ही लाइन में मिलाया गया। यह सवाल मिला, जहां हंस ने समस्या को समझाया: stackoverflow.com/questions/7070737/… ।

— नियोलिस्क

सुनिश्चित करें कि आप समापन </ para> टैग के रूप में अच्छी तरह से =)

— जोड़ते हैं

इसके बारे में बुरी बात यह है कि यह वास्तव में सिर्फ एक नई लाइन के बजाय एक पूरी खाली लाइन जोड़ता है।

— देवीद

तो क्या किसी को वास्तव में दो के बजाय एक पंक्ति सम्मिलित करने का एक तरीका मिल गया है?

Answer 2

यह मेरा उपयोग है, जैसे <br/>, यह काम कर रहा है :)

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

Comments

यह जवाब क्यों दिया गया है? यह काम करता है, और उपयोग करने की तुलना में एक बेहतर समाधान लगता है <para>&#160;</para>, <para>&nbsp;</para>या अदृश्य चरित्र ...

— Dinei

यह newlines के लिए काम करता है, लेकिन अन्य विकल्पों की तरह चीजों के बीच एक रिक्त रेखा नहीं डालेगा।

— युक्ताक्षर

वीएस के हाल के संस्करणों में <para/>एक लाइन ब्रेक को जोड़ने के लिए, न केवल एक लाइन ब्रेक लगता है।

— दीनी

@IlPADlI, +1 उपयोग उदाहरण के लिए। वीएस 2012 अंतिम अद्यतन 5 पर काम करने की पुष्टि 5.

— डेनिस टी

VS 2017: ब्लैंक लाइन जोड़ी गई, न सिर्फ लाइन ब्रेक ... microsoft यकीन है कि हमें बताना पसंद है कि हम क्या करना चाहते हैं ...

— Assimilater

Answer 3

विजुअल स्टूडियो 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>।

Comments

फिर भी उपयोगी है क्योंकि यह प्रश्न C # प्रलेखन में लाइन ब्रेक जोड़ने के लिए शीर्ष Google परिणाम है।

— दान

Answer 4

इसमें एक <para>विशेष चार, 255 चर, या अदृश्य चार के साथ एक टैग जोड़ें ।

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

यह इस तरह काम करेगा:

Comments

यह मददगार है, हालांकि  काम नहीं करता है, इसके बजाय उपयोग करें/// <para>&#160;</para>

— रॉबर्ट एच।

मैं व्यक्तिगत रूप /// <para> </para>से एक चिपचिपा नोट में रखता हूं । तो यह सिर्फ कॉपी और पेस्ट है! (और यह काम करता है - कम से कम मेरे लिए)

— जोएल

मुझे पता नहीं क्यों, लेकिन कॉपी पेस्ट /// <para> </para>बिल्कुल काम नहीं करता है। /// <para>&#160;</para>काम करता है!

— वेनकियांग

<para>पाठ के ब्लॉक के बीच टैग का उपयोग करने के बजाय , आपको तत्व में पहले को छोड़कर<para> सभी पैराग्राफ के चारों ओर टैग का उपयोग करना चाहिए । के लिए , , , , और तत्वों, उनके आसपास का उपयोग सभी अनुच्छेदों यदि आप एक से अधिक है (वैकल्पिक यदि आप केवल इन तत्वों के लिए एक है)। अन्य सभी ब्लॉक तत्वों के लिए (अन्य ब्लॉक तत्व के अंदर सहित ), सभी पैराग्राफ के चारों ओर टैग का उपयोग करें, भले ही आपके पास एक ही हो। <summary><typeparam><param><value><exception><returns><note><para>

— सैम हरवेल सेप

स्रोत: मैंने इसे प्रस्तुत किया, जिसमें अधिकांश प्रस्तुति शैली शामिल है: openstacknetsdk.org/docs-master/html/…

— सैम

Answer 5

<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