दिलचस्प पोस्ट
अजगर से प्रवाही प्रक्रिया रिक्त स्ट्रिंग विभाजित () परिणामों में क्यों लौटे हैं? कुल रूट क्या है? कैसे बैकग्राउंड रंग बदलने के लिए JTable ताज़ा होने के दौरान, जब भी स्वाइपफ़िफास लेआउट के साथ स्विच टुकड़ा, टुकड़ा फ्रीज होता है, लेकिन वास्तव में अभी भी काम करते हैं आईकंस और मैक विकास के लिए सतत एकीकरण के रूप में जेनकिंस / हडसन का उपयोग करते समय चाबी का गुच्छा में प्रमाण पत्र और कुंजियाँ गुम हैं क्लाइंट साइड पर जावास्क्रिप्ट में JPEG EXIF ​​रोटेशन डेटा एक्सेस करना हम लॉग इन जावा में लाइन नंबर कैसे मुद्रित कर सकते हैं इकाई फ़्रेमवर्क 6 कोड पहले डिफ़ॉल्ट मान अजगर: निष्पादन योग्य ज़िप फ़ाइलों में डेटा फ़ाइलों को शामिल किया जा सकता है? मैं 2 डी बहुभुज के क्षेत्र की गणना कैसे करूं? आप कैसे Websphere में JMX सक्षम करते हैं? मैं Windows कमांड लाइन से एप्लिकेशन निकास कोड कैसे प्राप्त करूं? jQuery के मोबाइल: ट्रिगर करने वाली पेज इवेंट का ऑर्डर क्या है? AngularJS के साथ कैसे $ http समकालिक कॉल करें

सी # एक्सएमएल टिप्पणियों से उत्पन्न प्रलेखन

मैंने हाल ही में एक नई परियोजना शुरू की है और मैं पहली बार सी # का उपयोग कर रहा हूं। मैंने पाया है कि जब विज़ुअल स्टूडियो आपकी कक्षाओं और विधियों को दस्तावेज बनाने के लिए सी # के XML टिप्पणियों को बनाने में सहायक है, तो आप MSDN या Javadoc शैली प्रलेखन उत्पन्न करने के लिए बहुत कुछ नहीं कर सकते।

गूगल मुझसे कहता है कि विजुअल स्टूडियो 2003 में ऐसे दस्तावेज बनाने के लिए एक उपकरण शामिल है, लेकिन यह अब आईडीई के बाद के संस्करणों में शामिल नहीं है।

अगर मेरे सावधानी से तैयार किए गए (मैं आपको आश्वस्त करता हूं!) XML मार्कअप का उपयोग करना चाहता हूं तो मेरे क्या विकल्प हैं?

वेब के समाधान से एकत्रित समाधान "सी # एक्सएमएल टिप्पणियों से उत्पन्न प्रलेखन"

उत्तर के लिए धन्यवाद, लेकिन Sandcastle को कॉन्फ़िगर करने और उपयोग करने के लिए थोड़ा दर्दनाक लगता है इसलिए मैं देख रहा हूं। मुझे सिर्फ एक और विकल्प मिल गया है – डोक्सीजन ।

डॉक्सीजन जेवाडॉक शैली प्रलेखन उत्पन्न करता है, हालांकि ऐसा लगता है कि इसका मुख्य रूप से आपकी टिप्पणियों के भीतर कस्टम मार्कअप से प्रलेखन करना है। जाहिर है, डॉक्सिजन भी सी # एक्सएमएल टिप्पणियाँ का समर्थन करता है, हालांकि मुझे इसकी वेबसाइट पर इसका कोई भी उल्लेख नहीं मिल रहा है!

वैसे भी, मैं इसे सलाह देते हैं यह उपयोग करना आसान है, कई भाषाओं का समर्थन करता है और आपके लिए क्लास आरेख भी उत्पन्न करता है।

आप इसे करने के लिए रेडकास्ट का उपयोग कर सकते हैं

इस पर कुछ संसाधन हैं: रेडकास्टल:

  • सैंडकैसल
  • Sandcastle सहायता फ़ाइल बिल्डर – जीयूआई
  • Sandcastle के लिए DocProject

सी # कोड के दस्तावेज पर लेख:

  • एक्सएमएल टिप्पणियाँ आप अपने विजुअल स्टूडियो से सीधे प्रलेखन बनाएँ। नेट स्रोत फ़ाइलें (MSDN पत्रिका पर)
  • सी # दस्तावेज़ीकरण और टिप्पणी (CodeProject पर)
  • सी # और एक्सएमएल सोर्स कोड प्रलेखन (CodeProject पर)
  • सी # ट्यूटोरियल पाठ 19: कोड प्रलेखन

क्या मैं विनम्रतापूर्वक सुझाव देता हूं कि ImmDoc.NET – एक सरल परियोजना जिसे मैंने कुछ समय पहले विकसित किया है और हाल ही में CodePlex पर प्रकाशित किया है। यह हल्के वजन, उपयोग करने में बहुत आसान है और .NET 2.0 का समर्थन करता है।

@ पोर्टमैन: एनडीओक मर चुका है और रेडकोसल अगले सर्वश्रेष्ठ (मृत होने के लिए) हो सकता है। डॉक्सिजन 'बॉक्स से सीधे' का इस्तेमाल करना इतना आसान है, यह भी बहुत विन्यास है।

इसमें GUI भी है जो कॉन्फ़िगरेशन और परीक्षण के साथ मदद करता है ताकि आप अपने दिल की सामग्री को ज़ूम कर सकें।

मुझे खुशी है कि आपको सबसे अच्छा विकल्प मिला – Doxygen! मैं सी # .NET के लिए Doxygen का उपयोग कर रहा हूं और यह क्लास आरेख, विरासत आरेख, इत्यादि उत्पन्न करता है। यहाँ एक सूचनात्मक ब्लॉग पोस्ट है ।

जेप्पन के उत्तर के लिए धन्यवाद जो मेरी मदद करते हैं, मैं उन सभी के लिए सरल बनाना चाहता हूं जो नेट। दस्तावेजीकरण बनाना चाहते हैं। मैं इस दस्तावेज़ को संदर्भ के रूप में उपयोग करता हूं:

सबसे पहले आपको "विज़ुअल स्टूडियो के लिए एक XML प्रलेखन फ़ाइल बनाना" सक्षम होना चाहिए (विज़ुअल स्टूडियो डिफ़ॉल्ट रूप से इस फ़ाइल को नहीं बनाते हैं):

प्रोजेक्ट पर राइट क्लिक करें और Properties चुनें जो गुण विंडो को लाते हैं। Build टैब का चयन करें और अंत में XML documentation file सक्षम करें। इस चरण के बाद सुनिश्चित करें कि आप अपना प्रोजेक्ट बनाएं

दूसरा, रेडकास्टल सहायता फ़ाइल बिल्डर डाउनलोड करें जो एक GUI प्रदान करके आसानी से दस्तावेज़ एपीआई बनाने में मदद करता है। नोटिस इसमें Sandcastle इंस्टॉलेशन फ़ाइल है, इसलिए आपको Sandcastle डाउनलोड करने की आवश्यकता नहीं है

अब एक दस्तावेज बनाना आसान है:

1- ओपन सेंडकेसल सहायता फ़ाइल बिल्डर और नई परियोजना बनाएं

2- Project Explorer Documentation Source पर क्लिक करें और Add Documentation Source चुनें।

3- फ़ोल्डर में नेविगेट करें जहां आपका डीएलएल असेंबली फ़ाइल और XML प्रलेखन फ़ाइल स्थित है (आमतौर पर बिन / डिबग फ़ोल्डर में)। असेंबली और एक्सएमएल फ़ाइल चुनें और Open बटन पर क्लिक करें।

4- Documentation मेनू में Build Project चयन करें।

इस चरण के बाद, सहायता आपके Sandcastle रूट फ़ोल्डर प्रोजेक्ट में और सहायता फ़ोल्डर में है।

लाइव दस्तावेज़र एक .NET टिप्पणी प्रलेखन उपकरण है I .NET के सभी संस्करणों के लिए काम करता है और सभी नई सुविधाओं का समर्थन करता है।

मुझे विश्वास नहीं हो सकता है कि यह 11 घंटे हो गया है और कोई भी एनडीओ का उल्लेख नहीं कर रहा है , जो वास्तव में आप की तलाश में हैं।

मैं इसका उपयोग करता हूं, केवल इसलिए क्योंकि Sandcastle अभी तक तैयार नहीं हुआ जब मैं इसकी आवश्यकता थी: CodeDoc

संपादित करें – मैंने उस नौकरी में इंटरनेट एक्सप्लोरर का इस्तेमाल किया, बस एहसास हुआ कि साइट फ़ायरफ़ॉक्स में काम नहीं करती है 🙁