मैं सोच रहा था कि दृश्य स्टूडियो में ऑटो उत्पन्न फ़ंक्शन हेडर बनाने का कोई तरीका (उम्मीद है कीबोर्ड शॉर्टकट) है या नहीं।
उदाहरण:
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)
और यह स्वचालित रूप से कुछ इस तरह हो जाएगा ...
'----------------------------------
'Pre:
'Post:
'Author:
'Date:
'Param1 (String):
'Param2 (Integer):
'Summary:
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)
जवाबों:
कि "तीन एकल टिप्पणी-मार्कर" बनाएं
C # में ///
जो डिफ़ॉल्ट रूप से बाहर थूकता है:
/// <summary>
///
/// </summary>
/// <returns></returns>GhostDoc !
फ़ंक्शन पर राइट-क्लिक करें, "यह दस्तावेज़" और चुनें
private bool FindTheFoo(int numberOfFoos)
हो जाता है
/// <summary>
/// Finds the foo.
/// </summary>
/// <param name="numberOfFoos">The number of foos.</param>
/// <returns></returns>
private bool FindTheFoo(int numberOfFoos)
(हाँ, यह सब स्वतः पूर्ण है)।
इसमें C #, VB.NET और C / C ++ का समर्थन है। यह प्रति डिफ़ॉल्ट प्रति मैप्ड Ctrl+ से Shift+ है D।
याद रखें: आपको दस्तावेज़ में विधि हस्ताक्षर से परे जानकारी जोड़नी चाहिए। बस ऑटोजेनरेटेड डॉक्यूमेंटेशन के साथ न रुकें। इस तरह एक उपकरण का मूल्य यह है कि यह स्वचालित रूप से प्रलेखन उत्पन्न करता है जिसे विधि हस्ताक्षर से निकाला जा सकता है, इसलिए आपके द्वारा जोड़ा गया कोई भी जानकारी नई जानकारी होनी चाहिए ।
कहा जा रहा है, मैं व्यक्तिगत रूप से पसंद करता हूं जब तरीके पूरी तरह से आत्मनिर्भर होते हैं, लेकिन कभी-कभी आपके पास कोडिंग-मानक होंगे जो दस्तावेज़ीकरण के बाहर जनादेश देते हैं, और फिर इस तरह का एक टूल आपको बहुत सारे ब्राइडेड टाइपिंग से बचाएगा।
///
विधि वर्णन टिप्पणी ब्लॉक प्राप्त करने के लिए शॉर्टकट है। लेकिन सुनिश्चित करें कि आपने इसे जोड़ने से पहले फ़ंक्शन का नाम और हस्ताक्षर लिखा है। पहले फ़ंक्शन का नाम और हस्ताक्षर लिखें।
फिर फ़ंक्शन नाम के ऊपर बस टाइप करें ///
और आप इसे स्वचालित रूप से प्राप्त करेंगे
विजुअल असिस्ट का एक अच्छा समाधान भी है, और यह बहुत ही महंगा है।
डॉक्स-शैली की टिप्पणियों को उत्पन्न करने के लिए इसे ट्विक करने के बाद, ये दो क्लिक उत्पन्न करेंगे -
/**
* Method: FindTheFoo
* FullName: FindTheFoo
* Access: private
* Qualifier:
* @param int numberOfFoos
* @return bool
*/
private bool FindTheFoo(int numberOfFoos)
{
}
(डिफ़ॉल्ट सेटिंग्स के तहत, यह थोड़ा अलग है।)
संपादित करें: 'डॉक्यूमेंट मेथड' टेक्स्ट को कस्टमाइज़ करने का तरीका VassistX-> विज़ुअल असिस्ट ऑप्शंस-> सुझाव के तहत है, 'एडिट वीए स्निपेट्स', भाषा: सी ++, टाइप: रिफैक्टरिंग, फिर 'डॉक्यूमेंट मेथड' पर जाएँ और कस्टमाइज़ करें। उपरोक्त उदाहरण द्वारा उत्पन्न होता है:
आम तौर पर, विज़ुअल स्टूडियो इसे स्वचालित रूप से बनाता है यदि आप उस टिप्पणी के ऊपर तीन एकल टिप्पणी-मार्कर जोड़ते हैं जो आप टिप्पणी करना चाहते हैं (विधि, वर्ग)।
C # में यह होगा ///।
यदि Visual Studio ऐसा नहीं करता है, तो आप इसे सक्षम कर सकते हैं
विकल्प-> टेक्स्ट एडिटर-> सी # -> उन्नत
और जाँच करें
/// के लिए XML दस्तावेज़ टिप्पणियाँ उत्पन्न करें
आप अपनी इच्छानुसार किसी भी लाइन को सम्मिलित करने के लिए कोड स्निपेट का उपयोग कर सकते हैं।
साथ ही, यदि आप फ़ंक्शन हेडर के ऊपर लाइन पर तीन सिंगल कोटेशन मार्क्स ('' ') टाइप करते हैं, तो यह XML हेडर टेम्प्लेट सम्मिलित करेगा जिसे आप फिर भर सकते हैं।
इन XML टिप्पणियों को दस्तावेज़ीकरण सॉफ़्टवेयर द्वारा व्याख्या किया जा सकता है, और उन्हें एक विधानसभा के रूप में बिल्ड आउटपुट में शामिल किया गया है। xml फ़ाइल। यदि आप उस XML फ़ाइल को DLL के साथ रखते हैं और उस DLL को किसी अन्य प्रोजेक्ट में संदर्भित करते हैं, तो वे टिप्पणियाँ intellisense में उपलब्ध हो जाती हैं।
मैं एक ओपन-सोर्स प्रोजेक्ट पर काम कर रहा हूं जिसे टोडोक कहा जाता है जो एक फाइल को सहेजते समय स्वचालित रूप से उचित प्रलेखन आउटपुट का उत्पादन करने के लिए शब्दों का विश्लेषण करता है। यह मौजूदा टिप्पणियों का सम्मान करता है और वास्तव में तेज और तरल है।