एक्सएमएल दस्तावेज़ीकरण में क्रेफ के लिए विजुअल स्टूडियो इंटेलिजेंस

Question

जब आप विजुअल स्टूडियो (मैं 2010 का उपयोग कर रहा हूं) में सी # विधियों के लिए एक्सएमएल दस्तावेज़ीकरण तैयार करता हूं, तो आपको विभिन्न एक्सएमएल टैग बनाने के लिए इंटेलिजेंस समर्थन मिलता है, जैसे देखें, पैराफ्रैफ़ इत्यादि। दूसरी तरफ, जब आप aa cref विशेषता में जोड़ते हैं तो आपको इसका उपयोग करना होगा, जो मुझे लगता है कि प्रकारों का वर्णन करने के लिए संकलित प्रारूप है। जब आपके पास कई जेनेरिक हैं तो यह सबसे खराब है।

जो मैं देख रहा हूं वह इस प्रकार है। यदि आप किसी तत्व तत्व में cref विशेषता सेट कर रहे हैं, तो आपके पास कक्षाओं की एक इंटेलिसेंस सूची है जो अब तक आपके द्वारा टाइप की गई मिलान से मेल खाती है और उसके बाद उचित प्रकार के विवरण को आउटपुट करता है। या जब आप एक paramref तत्व पर cref विशेषता सेट कर रहे हैं, तो आपको उस विधि के पैरामीटर की सूची प्राप्त होती है।

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

Answer 1

मैं हाल ही में बहुत सारे एक्सएमएल दस्तावेज लिख रहा हूं, और मुझे लगता है कि रीशर्पर उस कार्यक्षमता को प्रदान करता है जिसे आप अपनी विस्तारित इंटेलिसेन्स Code Completion सुविधा के साथ ढूंढ रहे हैं - मैं इसे हर समय उपयोग करता हूं। Quick Documentation सुविधा को दस्तावेज़ लिखते समय अनदेखा नहीं किया जाना चाहिए - इसके साथ, आप देख सकते हैं कि XML दस्तावेज़ वास्तव में HTML/chm पर संकलित होने पर कैसा दिखता है, और यह को वास्तविक समय में अपडेट किया गया है, इसलिए यदि मैं कुछ में बदलता हूं त्वरित दस्तावेज़ीकरण विंडो के साथ दस्तावेज़, मैं इसे स्वचालित रूप से बदलता देखता हूं - स्वरूपण और इस तरह के लिए वास्तव में सहायक।

आप मिश्रण करने के लिए Agent Smith जोड़ते हैं (जो केवल एक ऐड-ऑन ReSharper, जाहिरा तौर पर करने के लिए रूप में काम करता है), यह कुछ आसान वर्तनी, एक्सएमएल टिप्पणी मान्यता, नामकरण प्रथा चेकों की जांच कर रहा है, और कुछ सरल टिप्पणी जोड़ सकते हैं -फ्लोइंग (यदि आप पात्रों/रेखा की एक निश्चित संख्या में रहने के बारे में विशेष हैं) (पहले दो संभवतः सबसे उपयोगी होने के कारण रीशेर्पर नामकरण सम्मेलनों को लागू करने की क्षमता प्रदान करता है)।

आशा है कि मदद करता है!