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 मैं प्रलेखन और विशेषताओं के बारे में मिल सकता है इस विधि का सुझाव देने लगते हैं। वे सभी इनलाइन दस्तावेज के लिए एक्सएमएल का उपयोग करते हैं।
क्या इनलाइन दस्तावेज़ों में सहायता के लिए कोई अंतर्निहित विशेषता है? यदि नहीं, क्या कोई पुस्तकालय/पैकेज है जिसमें इनलाइन दस्तावेज़ के लिए विशेषताओं के प्री-डिफ़ाइंड सेट शामिल हैं?
बहुत सारे पुस्तकालय और पैकेज हैं जो XML दस्तावेज़टन से निपटते हैं। – Jodrell
क्या आपको वास्तव में प्रतिबिंब द्वारा ऐसी जानकारी खोजने की आवश्यकता है? आप प्रसिद्ध एक्सएमएल दस्तावेज को क्यों गठबंधन नहीं करते हैं, और कुछ स्रोत कोड संस्करण नियंत्रण (svn बिल्कुल दिखा रहा है कि क्या किया गया है)? आपके मामले में, क्या दो डेवलपर्स एक ही विधि/वर्ग बदल गए हैं? –
यह एक अच्छा विचार नहीं है, आईएमओ, क्योंकि आपको आम तौर पर रनटाइम में प्रलेखन की आवश्यकता नहीं होती है। एक्सएमएल दस्तावेज पहले से ही बदसूरत है, यह दृष्टिकोण भी उलझन में होगा। एक और जटिल विधि की कल्पना करने का प्रयास करें जहां वर्णन में कुछ पैराग्राफ होते हैं। यह गुणों के साथ कैसे दिखेंगे? –