2010-03-02 12 views
6

पर संलग्न वस्तुओं को जोड़ने के लिए कैसे मैं दस्तावेज़ टिप्पणियां लिखने की कोशिश कर रहा हूं हालांकि मुझे कोई समस्या है।< > द्वारा प्रलेखन टिप्पणियों

/// <summary> 
/// Inserts an element into the System.Collections.Generic.List<T> at the specified 
/// index. 
/// </summary> 

जब मैं <T> दृश्य स्टूडियो सोचता है कि मैं एक और टैग को जोड़ने के लिए कोशिश कर रहा हूँ तक पहुँचते हैं। इस तरह की टिप्पणियां जोड़ने का सही तरीका क्या है (और यदि मैं उन्हें जेनरेटेड हेल्प टेक्स्ट में सक्षम क्लिक कर सकता हूं जो अतिरिक्त बोनस होगा)

उत्तर

10

सी # प्रलेखन टिप्पणी एक्सएमएल हैं, इसलिए &lt; और &gt; करने के लिए अपने < और > बदल जाते हैं।

क्या आप बेहतर कर रहे हैं, यह है कि हाइपरलिंक डालने के लिए <see> टैग का उपयोग कर रहा है। एक <see> टैग में, बदल <T>{T} रहे हैं:

/// <summary> 
/// Inserts an element into the <see cref="List{T}"/> at the specified 
/// index. 
/// </summary> 

(ध्यान दें कि cref विशेषता वाक्य रचना-जाँच की साधारण पाठ के विपरीत संकलक द्वारा, है।)

0

चूंकि टिप्पणी xml है, तो आप xml के लिए उपयुक्त बचने के अनुक्रमों का उपयोग कर सकते हैं:

/// Inserts an element into the System.Collections.Generic.List&lt;T&gt; at the specified 
2

एक्सएमएल इकाइयों से बचें।

 
Change <T> into &lt;T&gt; 
2

मेरा मानना ​​है कि यह आपके लिए मदद मिलेगी: C# XML documentation comments FAQ

+0

धन्यवाद, मैं हमेशा एक अच्छी तरह से लिखा पूछे जाने वाले प्रश्न प्यार –

+0

अगर यह मदद करता है मुझे खुशी है - यह निश्चित रूप से समय पर मेरे लिए उपयोगी साबित कर दिया है । –

0

आपको उचित चार कोड का उपयोग करने की आवश्यकता है: &lt; और &gt;

आप एक <see cref="..."/> टैग में पूरे System.Collections.Generic.List < टी > surreound चाहते हैं।

मैं वास्तव में सही ढंग से इस उत्तर :) लिखने के लिए ऊपर उल्लेख किया टैग का इस्तेमाल किया था

संबंधित मुद्दे