Visual Studio में फ़ंक्शन के लिए IntelliSense में टिप्पणियां कैसे करें?

139

Visual Studio और C # में, जब एक अंतर्निहित फ़ंक्शन जैसे कि ToString () का उपयोग किया जाता है, तो IntelliSense एक पीला बॉक्स दिखाता है जो बताता है कि वह क्या करता है।

मेरे द्वारा लिखे गए कार्यों और गुणों के लिए मेरे पास कैसे हो सकता है?

— अली
स्रोत

215

ऐसा क्षेत्र बनाने के लिए जहां आप फ़ंक्शन के लिए विवरण और फ़ंक्शन के लिए प्रत्येक पैरामीटर निर्दिष्ट कर सकते हैं, अपने फ़ंक्शन से पहले लाइन पर निम्नलिखित टाइप करें और हिट करें Enter:

सी#: ///
वीबी: '''

प्रलेखन टिप्पणियों के लिए अनुशंसित टैग देखें ( संरचित सामग्री पर अधिक जानकारी के लिए C # प्रोग्रामिंग गाइड) आप इन टिप्पणियों में शामिल कर सकते हैं।

— Solmead
स्रोत

2

जोर देने के लिए: यह C ++ / C # में ट्रिपल-स्लैश है (सामान्य टिप्पणियां डबल-स्लैश हैं)। और VB में, इसके दो एकल-उद्धरण, दोहरे उद्धरण नहीं।

— abelenky 20

1

यह वास्तव में vb में तीन एकल उद्धरण है

— जोएल कोएहॉर्न

1

दरअसल, VB में, यह 3 एकल उद्धरण है: '' '

— गृहनगर

2

एक विकल्प के रूप में, VB फाइल में आप किसी फंक्शन या क्लास पर राइट क्लिक कर सकते हैं और "इन्सर्ट कमेंट" पर क्लिक कर सकते हैं। C # के लिए आप

— StyleCop का

घोस्टडॉक एक महान उपकरण है जो आपके लिए टिप्पणियों में बहुत सारे पाठ जोड़ सकता है। submain.com/products/ghostdoc.aspx

— Karl

74

आपको xml टिप्पणियों की क्या आवश्यकता है - मूल रूप से, वे इस सिंटैक्स का अनुसरण करते हैं (जैसा कि Solmead द्वारा वर्णित है):

सी#

///<summary>
///This is a description of my function.
///</summary>
string myFunction() {
     return "blah";
}

वीबी

'''<summary>
'''This is a description of my function.
'''</summary>
Function myFunction() As String
    Return "blah"
End Function

— टॉमस असचन
स्रोत

23

<c>text</c>- वह पाठ जिसे आप कोड के रूप में इंगित करना चाहते हैं।
< C > टैग आपको यह इंगित करने का एक तरीका देता है कि विवरण के भीतर पाठ को कोड के रूप में चिह्नित किया जाना चाहिए। कोड के रूप में कई लाइनों को इंगित करने के लिए < code > का उपयोग करें ।

<code>content</code>- आप जिस पाठ को कोड के रूप में चिह्नित करना चाहते हैं।
< Code > टैग आपको कोड के रूप में कई लाइनों को इंगित करने का एक तरीका देता है। यह बताने के लिए कि किसी विवरण के भीतर कोड के रूप में चिह्नित किया जाना चाहिए < c > का उपयोग करें ।

<example>description</example>- कोड नमूने का विवरण।
< उदाहरण > टैग आपको विधि या अन्य पुस्तकालय सदस्य का उपयोग करने के तरीके का एक उदाहरण निर्दिष्ट करता है। इसमें आमतौर पर < code > टैग का उपयोग किया जाता है ।

<exception cref="member">description</exception>- अपवाद का वर्णन।
< अपवाद > टैग आपको यह निर्दिष्ट करने देता है कि कौन से अपवाद फेंके जा सकते हैं। यह टैग विधियों, गुणों, घटनाओं और इंडेक्सर्स के लिए परिभाषाओं पर लागू किया जा सकता है।

<include file='filename' path='tagpath[@name="id"]' />
< शामिल > टैग आपको किसी अन्य फ़ाइल में टिप्पणियों का संदर्भ देता है जो आपके स्रोत कोड में प्रकार और सदस्यों का वर्णन करता है। यह आपके स्रोत कोड फ़ाइल में सीधे दस्तावेज़ टिप्पणियाँ रखने का एक विकल्प है। प्रलेखन को एक अलग फ़ाइल में रखकर, आप स्रोत कोड से अलग प्रलेखन के लिए स्रोत नियंत्रण लागू कर सकते हैं। किसी व्यक्ति के पास स्रोत कोड फ़ाइल की जाँच की जा सकती है और किसी और के पास दस्तावेज़ फ़ाइल की जाँच हो सकती है। < शामिल > टैग XML XPath सिंटैक्स का उपयोग करता है। अपने < शामिल > उपयोग को अनुकूलित करने के तरीकों के लिए XPath प्रलेखन देखें ।

<list type="bullet" | "number" | "table">
    <listheader>
        <term>term</term>
        <description>description</description>
    </listheader>
    <item>
        <term>term</term>
        <description>description</description>
    </item>
</list>

< Listheader > ब्लॉक का उपयोग किसी तालिका या परिभाषा सूची की हेडिंग पंक्ति को परिभाषित करने के लिए किया जाता है। एक तालिका को परिभाषित करते समय, आपको केवल शीर्षक में शब्द के लिए एक प्रविष्टि की आपूर्ति करने की आवश्यकता होती है। सूची में प्रत्येक आइटम को < आइटम > ब्लॉक के साथ निर्दिष्ट किया गया है । परिभाषा सूची बनाते समय, आपको शब्द और विवरण दोनों निर्दिष्ट करने की आवश्यकता होगी। हालाँकि, किसी तालिका, बुलेटेड सूची, या क्रमांकित सूची के लिए, आपको केवल विवरण के लिए प्रविष्टि की आपूर्ति करनी होगी। एक सूची या तालिका में आवश्यकतानुसार कई < आइटम > ब्लॉक हो सकते हैं।

<para>content</para>
< Para > टैग किसी टैग के अंदर उपयोग के लिए है, जैसे < सारांश >, < टिप्पणी >, या < रिटर्न >, और आपको पाठ में संरचना जोड़ने की सुविधा देता है।

<param name="name">description</param>
विधि के लिए किसी एक पैरामीटर का वर्णन करने के लिए विधि घोषणा के लिए टिप्पणी में < param > टैग का उपयोग किया जाना चाहिए। कई मापदंडों का दस्तावेजीकरण करने के लिए, कई < param > टैग का उपयोग करें।
< Param > टैग के लिए पाठ IntelliSense, ऑब्जेक्ट ब्राउज़र और कोड टिप्पणी वेब रिपोर्ट में प्रदर्शित किया जाएगा।

<paramref name="name"/>
< Paramref > टैग आपको यह इंगित करने का एक तरीका देता है कि कोड टिप्पणियों में एक शब्द, उदाहरण के लिए < सारांश > या < टिप्पणी > ब्लॉक में एक पैरामीटर को संदर्भित करता है। XML फ़ाइल को इस शब्द को कुछ अलग तरीके से प्रारूपित करने के लिए संसाधित किया जा सकता है, जैसे कि बोल्ड या इटैलिक फ़ॉन्ट।

< permission cref="member">description</permission>
< अनुमति > टैग आप एक सदस्य की पहुँच दस्तावेज़ सुविधा देता है। PermissionSet वर्ग आपको किसी सदस्य तक पहुंच निर्दिष्ट करता है।

<remarks>description</remarks>
< टिप्पणी > टैग का उपयोग एक प्रकार के बारे में जानकारी जोड़ने के लिए किया जाता है, जो < सारांश > के साथ निर्दिष्ट जानकारी को पूरक करता है । यह जानकारी ऑब्जेक्ट ब्राउज़र में प्रदर्शित होती है।

<returns>description</returns>
वापसी मूल्य का वर्णन करने के लिए एक विधि घोषणा के लिए टिप्पणी में < रिटर्न > टैग का उपयोग किया जाना चाहिए।

<see cref="member"/>
< देखें > टैग आपको पाठ के भीतर से एक लिंक निर्दिष्ट करने देता है। यह दर्शाने के लिए < seealso > का उपयोग करें कि पाठ को See See अनुभाग में रखा जाना चाहिए। कोड तत्वों के लिए आंतरिक हाइपरलिंक को प्रलेखन पृष्ठों पर बनाने के लिए cref विशेषता का उपयोग करें।

<seealso cref="member"/>
< Seealso > टैग आपको वह पाठ निर्दिष्ट करने देता है, जिसे आप एक See Also अनुभाग में दिखाना चाहते हैं। पाठ के भीतर से लिंक निर्दिष्ट करने के लिए < देखें > का उपयोग करें ।

<summary>description</summary>
एक प्रकार या एक प्रकार के सदस्य का वर्णन करने के लिए < सारांश > टैग का उपयोग किया जाना चाहिए। एक प्रकार के विवरण में पूरक जानकारी जोड़ने के लिए < टिप्पणी > का उपयोग करें । कोड तत्वों के लिए आंतरिक हाइपरलिंक बनाने के लिए सैंडकैसल जैसे प्रलेखन टूल को सक्षम करने के लिए cref विशेषता का उपयोग करें। < सारांश > टैग के लिए पाठ IntelliSense में टाइप के बारे में जानकारी का एकमात्र स्रोत है, और ऑब्जेक्ट ब्राउज़र में भी प्रदर्शित किया जाता है।

<typeparam name="name">description</typeparam>
एक टाइप पैरामीटर का वर्णन करने के लिए जेनेरिक प्रकार या विधि घोषणा के लिए टिप्पणी में < typeparam > टैग का उपयोग किया जाना चाहिए। जेनेरिक प्रकार या विधि के प्रत्येक प्रकार के पैरामीटर के लिए एक टैग जोड़ें। ऑब्जेक्ट टाइप कोड ब्राउज़र वेब रिपोर्ट में < typeparam > टैग के लिए पाठ IntelliSense में प्रदर्शित किया जाएगा।

<typeparamref name="name"/>
दस्तावेज़ीकरण फ़ाइल के उपभोक्ताओं को शब्द को कुछ अलग तरीके से प्रारूपित करने में सक्षम करने के लिए इस टैग का उपयोग करें, उदाहरण के लिए इटैलिक में।

<value>property-description</value>
< Value > टैग आपको उस मूल्य का वर्णन करने देता है जो एक संपत्ति का प्रतिनिधित्व करता है। ध्यान दें कि जब आप Visual Studio .NET डेवलपमेंट वातावरण में कोड विज़ार्ड के माध्यम से कोई गुण जोड़ते हैं, तो यह नई संपत्ति के लिए < सारांश > टैग जोड़ेगा । फिर आपको उस मूल्य का वर्णन करने के लिए मैन्युअल रूप से एक < value > टैग जोड़ना चाहिए जो संपत्ति का प्रतिनिधित्व करता है।

— मैक्स
स्रोत

11

XML टिप्पणी, इस तरह से करें

/// <summary>
/// This does something that is awesome
/// </summary>
public void doesSomethingAwesome() {}

— माइकल वाल्ट्स
स्रोत

6

मापदंडों में जोड़ें:///<param name="paramName">Tralala</param>

— द ओडलर

10

टिप्पणी की प्रत्येक पंक्ति शुरू करने के लिए /// का उपयोग करें और टिप्पणी में मेटा डेटा रीडर के लिए उपयुक्त xml है ।

///<summary>
/// this method says hello
///</summary>
public void SayHello();

हालांकि व्यक्तिगत रूप से, मेरा मानना है कि ये टिप्पणियां आम तौर पर गुमराह होती हैं, जब तक कि आप ऐसी कक्षाएं विकसित नहीं कर रहे हैं जहां कोड को उसके उपभोक्ताओं द्वारा पढ़ा नहीं जा सकता है।

— DevelopingChris
स्रोत

2

वे शॉर्टकट अनुस्मारक के लिए अच्छे हैं, या कहीं भी आपके पास लाइब्रेरी कोड है जहां शायद कोड पढ़ने योग्य है, लेकिन इसे प्राप्त करने के लिए थोड़ा अतिरिक्त काम करना पड़ता है।

— जोएल कोएहॉर्न

1

मैं सिद्धांत रूप में आपके साथ सहमत हूं, लेकिन यदि आप उस भुतहा चीज का उपयोग करते हैं, तो आप शोर / संकेत अनुपात को इस हद तक बढ़ा रहे हैं कि बाकी टिप्पणियां बेकार हैं।

— विकासशील

9

जिन्हें XML कमेंट्स कहा जाता है । वे हमेशा से विजुअल स्टूडियो का हिस्सा रहे हैं।

आप घोस्टडोक का उपयोग करके अपनी प्रलेखन प्रक्रिया को आसान बना सकते हैं , विजुअल स्टूडियो के लिए एक मुफ्त ऐड-इन जो कि आपके लिए XML-doc टिप्पणियों को उत्पन्न करता है। अपना ध्यान उस पद्धति / संपत्ति पर रखें, जिसे आप दस्तावेज़ में रखना चाहते हैं, और Ctrl-Shift-D दबाएं।

यहाँ मेरी एक पोस्ट से एक उदाहरण है ।

उम्मीद है की वो मदद करदे :)

— इगल तबाचनिक
स्रोत

6

CSharp में, यदि आप इसके साथ Parms के लिए विधि / फ़ंक्शन की रूपरेखा बनाते हैं, तो जब आप तीन फ़ॉरवर्ड स्लैश जोड़ते हैं, तो यह सारांश और parms सेक्शन को ऑटो करेगा।

इसलिए मैंने इसमें डाला:

public string myMethod(string sImput1, int iInput2)
{
}

मैंने इसके बाद तीन /// रखा और विजुअल स्टूडियो ने मुझे यह दिया:

/// <summary>
/// 
/// </summary>
/// <param name="sImput1"></param>
/// <param name="iInput2"></param>
/// <returns></returns>
public string myMethod(string sImput1, int iInput2)
{
}

— Semperfi89
स्रोत

6

इस तरह से तरीके को परिभाषित करें और आपको आपकी जरूरत के हिसाब से मदद मिलेगी।

    /// <summary>
    /// Adds two numbers and returns the result
    /// </summary>
    /// <param name="first">first number to add</param>
    /// <param name="second">second number to </param>
    /// <returns></returns>
    private int Add(int first, int second)
    {
        return first + second;
    }

कोड उपयोग का स्क्रीनशॉट

— यिल्डिज़ प्राप्त करें
स्रोत

4

http://msdn.microsoft.com/en-us/library/3260k4x7.aspx पढ़ें केवल टिप्पणियों को निर्दिष्ट करने से अंतःविषय में मदद टिप्पणी नहीं दिखाई देगी।

— user1180781
स्रोत

यदि आपके पास XML टिप्पणियां सक्षम हैं, तो वे नीचे मेरा जवाब देखें।

— Suncat2000

2

ये सभी अन्य उत्तर समझ में आते हैं, लेकिन अधूरे हैं। विज़ुअल स्टूडियो XML टिप्पणियों को संसाधित करेगा, लेकिन आपको उन्हें चालू करना होगा। यहाँ है कि कैसे करना है:

Intellisense आपके स्रोत कोड में आपके द्वारा दर्ज की गई XML टिप्पणियों का उपयोग करेगा, लेकिन आपको उन्हें Visual Studio विकल्प के माध्यम से सक्षम करना होगा। पर जाएं Tools> Options> Text Editor। Visual Basic के लिए, Advanced> Generate XML documentation comments for '''सेटिंग सक्षम करें । C # के लिए, Advanced> Generate XML documentation comments for ///सेटिंग सक्षम करें । इंटेलीजेंस दर्ज करने पर सारांश टिप्पणियों का उपयोग करेगा। संदर्भित परियोजना संकलित होने के बाद वे अन्य परियोजनाओं से उपलब्ध होंगे।

बनाने के लिए बाहरी प्रलेखन, आप के माध्यम से एक XML फ़ाइल उत्पन्न करने के लिए की जरूरत है Project Settings> Build> XML documentation file:रास्ता है कि नियंत्रण संकलक के /docविकल्प। आपको एक बाहरी टूल की आवश्यकता होगी जो XML फाइल को इनपुट के रूप में लेगा और आउटपुट फॉर्मेट की आपकी पसंद में प्रलेखन उत्पन्न करेगा।

ध्यान रखें कि XML फ़ाइल उत्पन्न करने से आपका संकलन समय बढ़ सकता है।

— Suncat2000
स्रोत

1

इसके अलावा, दृश्य स्टूडियो एड-इन घोस्ट डॉक आपके फ़ंक्शन नाम से हेडर टिप्पणियों को बनाने और भरने का प्रयास करेगा।

— मार्क रोजर्स
स्रोत

0

सोलमेड का सही उत्तर है। अधिक जानकारी के लिए आप XML टिप्पणियाँ देख सकते हैं ।

— एड एस।
स्रोत