2011-07-20 23 views
11

मैं अपने स्वयं के दस्तावेज़ में this MSDN page पर टिप्पणी अनुभाग में पीले 'नोट:' बॉक्स में एक समान चीज़ प्राप्त करना चाहता हूं।सी # एक्सएमएल दस्तावेज: नोट्स कैसे बनाएं?

मैं प्रलेखन टैग से संदर्भ वेबसाइट उत्पन्न करने के लिए sandcastle और sandcastle मदद फ़ाइल निर्माता का उपयोग कर रहा हूं। ऐसे नोट्स बॉक्स को प्राप्त करने के लिए मुझे क्या लिखना है?

उत्तर

13
/// <summary><c>Increment</c> method increments the stored number by one. 
/// <note type="caution"> 
/// note description here 
/// </note> 
/// </summary> 

फ़ाइल पर देखो "C: \ Program Files \ सैंडकैसल \ उदाहरण \ सैंडकैसल \ test.cs"

प्रकार हो सकता है में से एक:

  • टिप्पणी
  • टिप
  • सावधानी
  • सुरक्षा
  • महत्वपूर्ण
  • vb/वीबी/VisualBasic/दृश्य बुनियादी टिप्पणी
  • सीएस/CSharp/सी #/सी #/दृश्य ग # टिप्पणी
  • सीपीपी/C++/C++/सीपीपी/दृश्य ग ध्यान दें ++
  • JSharp/j #/जम्मू #/दृश्य j # टिप्पणी
  • फोन करने वाले
  • इनहेरिट लागू
+0

कूल। वह बस काम करता है! 'ऑफिकल' सूची में टैग नहीं मिला, लेकिन यह जानना अच्छा है कि एनडीओसी टैग भी समर्थित हैं। –

+0

हां। यह आधिकारिक तौर पर समर्थित नहीं है, लेकिन सैंडकास्टल बिल्कुल एनडीओसी के साथ प्रेरित था: http://blogs.msdn.com/b/sandcastle/archive/2006/11/22/supporting-custom-tags-in-sandcastle.aspx – chopikadze

+0

THX, मुझसे +1 बस एक साइड-नोट: मुझे लगता है कि आपको आमतौर पर

अनुभाग में एस शामिल नहीं करना चाहिए। अधिक उपयुक्त होना चाहिए। –

0

नहीं एक सीधा समाधान है, लेकिन एक विकल्प:

NDoc एक <note> टैग का समर्थन करता है। चूंकि एनडीओसी पुराना है, इसलिए आप इस सुविधा को NDoc3 में देख सकते हैं, जो निश्चित रूप से देखने योग्य है क्योंकि यह सादे HTML दस्तावेज़ बनाने में भी सक्षम है, न केवल ऑनलाइन दस्तावेज़ जो एएसपीनेट मानता है।

+0

धन्यवाद, लेकिन अपने बुनियादी ढांचे को पहले से ही अनुसूचित जाति पर निर्भर करता है और है कि आसानी से नहीं बदला जा सकता। –