2012-05-03 11 views
20

मैं लाला भूमि में कोडिंग कर रहा था जब अचानक मैंने एक टिप्पणी में 3'd '/' टाइप किया था। मूल रूप से एक टिप्पणी चला जाता है हरी के साथ 2 '/' रों :सी # में पंक्ति में 3 '/' क्या करता है?

Subject1

लेकिन तीसरे पानी का छींटा के साथ, यह जाता है ग्रे '///' :

Subject2

क्या इसका कोई विशिष्ट अर्थ है? या यह सिर्फ रंग बदल गया?

+19

निश्चित रूप से रंग के बारे में है, तो आप /doc: विकल्पों का उपयोग कर /doc: विकल्पों का उपयोग करके XML दस्तावेज़ भी बना सकते हैं। जैसे चीजों को लाल बनाने के बारे में है ;-) – Joey

उत्तर

34

यह एक एक्सएमएल कॉमेंट को दर्शाता है, जिनमें से अधिक MSDN पर पढ़ा जा सकता है। उदाहरण के लिए,

/// <summary> 
/// Method summary - a method that does something 
/// </summary> 
/// <param name="i">Description of param</param> 
/// <param name="s">Description of param</param> 
/// <returns>An object of some sort or other</returns> 
public object AMethod(int i, string s) 
{ 
} 

संपादित करें: नीचे के रूप में सुझाव दिया है, यह भी, IntelliSense मार्गदर्शन प्रदान करता है के रूप में छवि के नीचे प्रदर्शित करता है।

Enter image description here

+4

उल्लेखनीय है कि साथ ही दस्तावेज उत्पन्न करने के लायक हो, ये विजुअल स्टूडियो में इंटेलिसेंस पॉपअप के लिए भी विवरण प्रदान करते हैं। –

+1

अच्छा विचार, जोड़ा है। – glosrob

+0

अच्छी तरह से भी किया। यद्यपि आप उस रंग योजना के साथ कैसे काम करते हैं ...;) –

5

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

इस प्रकार आप Visual Studio: link का उपयोग करके इन टैग से दस्तावेज़ों को उत्पन्न करते हैं।

1

/// एक्सएमएल टिप्पणी के लिए है। यह एक एक्सएमएल प्रारूपित टिप्पणी प्रदान करता है।