का उपयोग गुण

Question

MSDN Attributes Tutorial में वे एक विशेषता के लिए एक उदाहरण के रूप Author का उपयोग करें:

[Author("Jane Programmer", Version = 2), IsTested()] 
class Order 
{ 
    // add stuff here ... 
} 

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

[Author("Me")] 
[Description("Add 1 to value")] 
[Param("value", "The original value to add 1 to")] 
public int AddOne(value) {return value + 1;} 

हालांकि कोई भी oftheanswers मैं प्रलेखन और विशेषताओं के बारे में मिल सकता है इस विधि का सुझाव देने लगते हैं। वे सभी इनलाइन दस्तावेज के लिए एक्सएमएल का उपयोग करते हैं।

क्या इनलाइन दस्तावेज़ों में सहायता के लिए कोई अंतर्निहित विशेषता है? यदि नहीं, क्या कोई पुस्तकालय/पैकेज है जिसमें इनलाइन दस्तावेज़ के लिए विशेषताओं के प्री-डिफ़ाइंड सेट शामिल हैं?

Answer 1

विशेषताओं में प्रलेखन रखने से कुछ नुकसान:

• लंबे ग्रंथों के लिए गरीब स्वरूपण;
• विजुअल स्टूडियो ऐड-ऑन द्वारा कोई समर्थन नहीं (उदाहरण के लिए रीशर्पर के दस्तावेज़ पूर्वावलोकन सुविधा का उपयोग करना);
• तृतीय पक्ष प्रलेखन उत्पादन उपकरण द्वारा कोई समर्थन नहीं;
• असेंबली में दस्तावेज़ीकरण शामिल करना जो रिवर्स इंजीनियरिंग को काफी आसान बनाता है;
• एक संस्करण नियंत्रण प्रणाली में संग्रहीत मेटाडेटा के साथ स्रोत कोड में मेटाडेटा का डुप्लिकेशन (स्रोत कोड में किसी भी घोषणा के लेखक और संस्करण को ट्रैक करने में कोई बात नहीं है, जब वीसीएस आपको अधिक सटीक जानकारी देता है - वीसीएस नहीं है)।

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

Answer 2

यहां प्रश्न यह है कि 'दस्तावेज़ीकरण क्या है?'। यदि आपकी रुचि रखने वाली 'सामान' को प्रतिबिंब द्वारा सुलभ करने की आवश्यकता है तो गुणों का आपका अंतर्निहित समाधान एक समाधान है। लेकिन अगर इरादा दस्तावेज बनाने के लिए मानक दस्तावेज उपकरण का उपयोग करना है तो ऐसा नहीं है।

यहां आवश्यकता समाधान का समाधान करती है। 'दस्तावेज' की आवश्यकता क्या है। शायद गलत सवाल?

Answer 3

बस पूर्णता के लिए के लिए यह उल्लेख करने के लिए, परीक्षण परियोजनाओं में तुम कर सकते हो:

[TestProperty(“Author”, “Ducky”)] 
public void SomeTest() 
{ 
     ... 
} 

आप नियमित रूप से कोड के लिए कि दृष्टिकोण का विस्तार कर सकते हैं। मैं सैद्धांतिक मुद्दों पर टिप्पणी नहीं करता हूं। उस ने कहा, संभवतः विशिष्ट फ़ाइल/वर्ग/विधि के सभी "लेखकों"/"संपादकों" निकालने के लिए रिपॉजिटरी का उपयोग करने वाली स्क्रिप्ट बनाई जा सकती है।