2008-09-15 17 views
32

सी # दस्तावेज टैग में आप एमएसडीएन के समान उत्पादन का उत्पादन करने की अनुमति देते हैं। कक्षाओं, विधियों और गुणों के ऊपर /// (ट्रिपल स्लैश) टिप्पणी क्षेत्र के अंदर उपयोग के लिए स्वीकार्य टैग की एक सूची क्या है? 2002 सेसी # दस्तावेज टैग क्या हैं?

उत्तर

6
+7

हां, डोमेन की समयसीमा समाप्त हो गई है और यह एक टूटा हुआ लिंक है। –

+0

ठीक है कि बदबू आ रही है - Google कैश में अभी भी है, लेकिन कितनी देर तक, कौन जानता है? –

+1

मुझे लगता है कि यह जावाडॉक्स की तरह ही है जब आप इसे किसी वेबपृष्ठ पर प्रकाशित करते हैं। यहां अधिक अपडेट किया गया लिंक: http://msdn.microsoft.com/en-us/library/b2s063f7.aspx – puretppc

2

(टैग को देखने के लिए नीचे जाएं) उत्कृष्ट MSDN लेख देखें here आपका पहला स्टॉप के रूप में।

3

GhostDoc आपकी विधि/कक्षा के लिए एक स्टब टिप्पणी बनाकर मदद करता है।

12

तुम सिर्फ एक विधि या वर्ग के ऊपर इस लिखते हैं, तो IntelliSense उपलब्ध टैग की एक सूची के साथ संकेत चाहिए:

/// < 
+0

सामान्य रूप से उनका क्या मतलब है? आप उन्हें निर्दिष्ट करने के लिए किस आदेश का उपयोग करना चाहिए? प्रत्येक के लिए उचित उपयोग के मामले क्या होंगे? क्या संभव है, लेकिन आधुनिक विकास अभ्यास में निराश? – Neolisk

10

यहाँ एक सूची है:

  • सारांश
  • परम
  • रिटर्न
  • उदाहरण
  • कोड
  • देख
  • seealso
  • सूची
  • मूल्य
  • फ़ाइल
  • कॉपीराइट

यहाँ एक उदाहरण है:

 
<file> 
<copyright>(c) Extreme Designers Inc. 2008.</copyright> 
<datecreated>2008-09-15</datecreated> 
<summary> 
Here's my summary 
</summary> 
<remarks> 
<para>The <see cref="TextReader"/> can be used in the following ways:</para> 
<list type="number"> 
<item>first item</item> 
<item>second item</item> 
</list> 
</remarks> 
<example> 
<code> 
System.Console.WriteLine("Hello, World"); 
</code> 
</example> 
<param name="aParam">My first param</param> 
<returns>an object that represents a summary</returns> 
</file> 
+5

सी # – Nap

+1

के लिए कोई लेखक टैग नहीं है यदि मेरे पास एक यूआरएल है तो मुझे अधिक जानकारी के लिए इंगित करने की आवश्यकता है? मैं कहां रखूं? –

+0

@ केविन ड्रिगर - मेरा सुझाव है कि आप सूची संपादित करें और 'लेखक' टैग को हटा दें। एक पल के लिए मुझे वहां देखने में खुशी हुई और फिर मैं नेप की वोट टिप्पणी पढ़ने और इसे [लिंक प्रदान किए गए लिंक] के साथ खुद को देखकर निराश था (http://web.archive.org/web/20100118163744/http:// thoughtpad.net/alan-dean/cs-xml-documentation.html) [डेविड मोहुंड्रो द्वारा] (https://stackoverflow.com/a/65989/978502) – yair

1

के लिये दस्तावेज के अंदर देखो। यह .NET के लिए नया दस्तावेज़ मानक है।

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