विजुअल स्टूडियो 2010 में दस्तावेज (एक्सएमएल) एप्लीकेशन सेटिंग्स

Question

मैंने हाल ही में विजुअल स्टूडियो (2010) के साथ एक (सी #) प्रोजेक्ट बनाया है और कुछ सेटिंग्स (जिसे मैंने गुणों के तहत बनाया है) का उपयोग किया है।

एकमात्र जगह मैंने पाया जहां मैं अपने दस्तावेज़ों के लिए कुछ एक्सएमएल टिप्पणियां जोड़ सकता हूं, सेटिंग्स.डिज़ाइनर सीएस में होगा। हालांकि यह फ़ाइल स्वत: जेनरेट की गई है, इसलिए जब भी मैं सेटिंग्स बदलता हूं, टिप्पणियां समाप्त हो जाती हैं।

यहां तक ​​कि दृश्य स्टूडियो mewarnings देने शुरू कर दिया देता है, "प्रचार के लिए एक्सएमएल टिप्पणी गुम दिख लिखें या सदस्य ...."

मेरा प्रश्न यहाँ है: neatest तरीका मेरी सेटिंग पर एक्सएमएल टिप्पणियां जोड़ने के लिए क्या है?

• क्या सेटिंग्स.Designer.cs से बेहतर स्थान है?
• क्या मुझे फ़ाइल को स्वतः उत्पन्न होने से रोकना चाहिए? कैसे?
• कोई अन्य तरीका?

मैं जिस तरह से

Answer 1

यदि आप अपनी सेटिंग्स (डिफ़ॉल्ट डिज़ाइनर का उपयोग करके) खोलते हैं, तो आप गुण विंडो संपत्ति "विवरण" में पा सकते हैं। इसे भरें और इसका उपयोग ऑटोगनेरेटेड फ़ाइल में एक्सएमएल टिप्पणी सारांश के रूप में किया जाएगा।

Answer 2

यह क्या द्वारा सैंडकैसल मदद फ़ाइल बिल्डर उपयोग कर रहा हूँ। मुझे अभी भी यकीन नहीं है कि कोई बेहतर तरीका है, लेकिन मैंने अपने Sandcastle HFB प्रोजेक्ट में सेटिंग्सDoc.xml जोड़ा। नुकसान यह है कि यह विजुअल स्टूडियो द्वारा संकलित नहीं किया जाता है, इसलिए मुझे संदर्भों को अद्यतन करने और जांचने की आवश्यकता है।

Answer 3

अपनी सेटिंग्स में। सेटिंग्स फ़ाइल (इसे डिज़ाइनर के साथ न खोलें), एक विशेषता जोड़ें, उदा। "विवरण":

<Setting Name="MySetting" Description="This property does blah blah blah" Type="System.Int32" Scope="Application"> 
    <Value Profile="(Default)">42</Value> 
</Setting> 

यह

/// <summary> 
/// This property does blah blah blah 
/// </summary> 
[global...] 
public int MySetting { ... 

उत्पन्न होगा तुम भी एक ऐसा टूल है Settings.settings फ़ाइल लेता है का निर्माण और एक MAML विषय फ़ाइल बना सकते हैं। अपने प्रोजेक्ट के निर्माण ईवेंट और voilà में टूल को कॉल करें।

मेरे परीक्षणों में, यदि आप सेटिंग तत्व की विशेषता के रूप में विवरण डालते हैं, तो यह रखा जाएगा यदि आप डिज़ाइनर में सेटिंग बदलते हैं, तो विशेषता रखी जाएगी। हालांकि, अगर आप इसे सेटिंग तत्व के बच्चे के रूप में रखते हैं, तो इसे हटा दिया जाएगा।