2011-03-14 20 views
27

ग्रहण से मुझे उपयोग किया जाता है कि जब मैं किसी वर्ग या विधि के लिए कोई टिप्पणी लिखना शुरू करता हूं, पैरामीटर, रिटर्न प्रकार और अपवाद स्वत: उत्पन्न होते हैं। लेकिन विजुअलस्टूडियो 2010 में मुझे ऐसा कुछ नहीं मिल रहा है। कोई संकेत यह कैसे प्राप्त करने के लिए?विजुअल स्टूडियो 2010 और सी # में स्वचालित रूप से टिप्पणियां कैसे उत्पन्न करें?

+3

ध्यान दें कि, सी # में, "अपवाद" आमतौर पर टिप्पणी नहीं की जाती है, क्योंकि उन्हें जावा में विधि स्तर पर परिभाषित नहीं किया जाता है ... –

उत्तर

85

मुझे ऐसा करने का एकमात्र तरीका आपकी विधि के ठीक ऊपर लाइन पर है, बस "///" टाइप करें और यह विधि के आधार पर एक टिप्पणी टेम्पलेट उत्पन्न करेगा।

+3

जो मुझे विधि लिखने से पहले मेरी टिप्पणियां लिखने के लिए सिखाएगा, इसलिए कि मैं इस बात पर ध्यान केंद्रित कर रहा हूं कि मैं क्या करने का तरीका चाहता हूं! –

+3

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

1

किसी विधि से आगे एक पंक्ति "///" टाइप करने का प्रयास करें। मुझे बताओ कि क्या आप यही चाहते हैं।

5

टिप्पणियों के लिए "//" के बजाय "////" का उपयोग करें। उदाहरण के लिए, निम्नलिखित टिप्पणी था स्वत: जनरेट सिर्फ टाइप करने के लिए "///" शुरू करने से:

/// <summary> 
/// </summary> 
/// <param name="terms"></param> 
public TVec(IEnumerable<Term> terms) 
{ 
} 
+0

'' 'किसी के लिए दृश्य मूल में ऐसा करने के लिए चाहते हैं :) – user2728841

11

GhostDoc एक नि: शुल्क विस्तार है जो यह कर देगा है। किसी विधि के भीतर कहीं भी Ctrl + D को डिफ़ॉल्ट रूप से दबाएं, और यह एक्सएमएल दस्तावेज़ीकरण टिप्पणियों को भरने वाले डिफ़ॉल्ट के साथ जोड़ देगा (हालांकि उन्हें आम तौर पर संशोधित/विस्तारित किया जाना चाहिए)।

+2

बस ध्यान रखना चाहते हैं: केवल व्यक्तिगत उपयोग के लिए नि: शुल्क। यदि आप परवाह करते हैं ;-) – schoetbi

1

आप अपने xml टिप्पणियों के बहुत उत्पन्न करने के लिए Ghostddoc उपयोग कर सकते हैं: http://submain.com/products/ghostdoc.aspx

मुझे लगता है कि एक मुक्त संस्करण उपलब्ध है।

संबंधित मुद्दे