वीएस 2010 में चर/फ़ील्ड/सूचियों के लिए टिप्पणियां/दस्तावेज़ीकरण कैसे लिखें?

Question

वर्ग या तरीकों के लिए

///<summary> 
///This is summary for some class or method 
///</summary> 

प्रलेखन नहीं है। लेकिन सरल चर या सूचियों के लिए इसे कैसे लिखना है?

मैं विजुअल स्टूडियो 2010 का उपयोग करता हूं और जब मैं कुछ सूची, संपत्ति या कभी भी कुछ प्रकार के सारांश (उस छोटे टूलटिप में) को देखना चाहता हूं तो मैंने उस विशिष्ट चीज़ को लिखा है।

///<doc> 
///always use this list! 
List<String> beer = new List<String>(); 

संपादित करें: ठीक है, हमें पता चला है कि यह अपनी कक्षा में लेकिन एक विधि या एक समारोह के बाहर लंबे समय यू टिप्पणी के रूप में हमेशा की तरह काम करता है !!

किसी विधि के भीतर दस्तावेज़/टिप्पणी करने का कोई तरीका भी?

public class BeerForall 
{ 
    /// <summary> 
    /// it works here 
    /// </summary> 
    public List<String> beer = new List<string>(); 

    public String giveBeer() 
    { 
     /// is not working, u can not comment 
     /// <summary> 
     /// test test, not working 
     /// </summary> 
     List<String> moreBeer = new List<string>(); 

     return "beer"; 
    } 
} 

Answer 1

विजुअल स्टूडियो 2010 में पूरी तरह से ठीक काम करने लगता है। मैंने अपनी मुख्यफॉर्म कक्षा के अंदर एक टिप्पणी के साथ एक निजी क्षेत्र के रूप में एक सूची परिभाषित की है।

वे स्थानीय चर के लिए काम नहीं करेंगे हालांकि कार्यों के भीतर परिभाषित किया गया है।

Answer 2

वैसे ही जैसे आप कक्षाओं और विधियों के लिए सारांश लिखते हैं चर के लिए काम करते हैं।

Answer 3

आप किसी भी XML documentation टिप्पणियों को कक्षा सदस्य, सदस्य (विधि, संपत्ति, आदि) के अंदर नहीं जोड़ सकते हैं।

Answer 4

जहाँ तक मुझे पता है, IntelliSense के लिए जोड़ने की टिप्पणियां स्थानीय चर कार्यों के भीतर घोषित के लिए काम नहीं करेगा। यदि आप अपनी स्थानीय सूची कक्षा के एक आवृत्ति चर बनाने के लिए थे, तो आप यह करने में सक्षम होंगे।

Answer 5

जैसा कि अन्य लोगों ने उल्लेख किया है, आप स्थानीय वर्रों के लिए इंटेलिसेन्स नहीं प्राप्त कर सकते हैं। हालांकि: यदि आपका फ़ंक्शन इतना बड़ा है कि "नियमित" टिप्पणी उस स्थान के पास पढ़ने के लिए पर्याप्त नहीं है जहां आप var का उपयोग कर रहे हैं, तो सही फ़िक्स फ़ंक्शन को दोबारा करने के लिए है - इसे एकाधिक में विभाजित करें, कम वर्स के साथ छोटे तरीके। मुझे नहीं लगता कि यह फीचर मौजूद होना चाहिए, क्योंकि यह केवल अत्यधिक बड़े कार्यों को लिखने में सहायता करेगा।

Answer 6

संपादित करें: ऐसा लगता है कि <var> केवल जावास्क्रिप्ट के लिए समर्थित है।

विजुअल स्टूडियो 2012 के रूप में आप <var> तत्व का उपयोग करके इस दस्तावेज़ को जोड़ सकते हैं।

यहाँ उस पर माइक्रोसॉफ्ट के प्रलेखन है:
https://msdn.microsoft.com/en-us/library/hh542722(v=vs.110).aspx