डॉकप्रोजेक्ट बनाम सैंडकासल सहायता फ़ाइल बिल्डर जीयूआई

Question

मेरे पास कई आंतरिक लाइब्रेरी घटकों के साथ कई सी # परियोजनाएं हैं जिन्हें मैं एक साथ दस्तावेज़ करने की कोशिश कर रहा हूं। लगता है कि सैंडकैसल सी # से दस्तावेज उत्पन्न करने के लिए जाने वाला स्थान है। मैं जानना चाहता हूं कि दो में से कौन सा, डॉकप्रोजेक्ट या सैंडकासल हेल्प फाइल बिल्डर जीयूआई बेहतर है और मुझे आवश्यक सुविधाओं का समर्थन करता है।

मैं केवल प्रत्येक परियोजना को दस्तावेज़ के अपने हिस्से को संकलित करना चाहता हूं और फिर इसे अंत में एक साथ एकीकृत करना चाहता हूं। (यानी एक प्रलेखन प्रोजेक्ट में लाइब्रेरी घटक और प्रत्येक प्रोजेक्ट में अपनी प्रोजेक्ट प्रोजेक्ट में, फिर उपरोक्त सभी मदद 2 व्यूअर का उपयोग कर एक रूट में)

Answer 1

मैं Sandcastle सहायता फ़ाइल बिल्डर के लिए प्रतिबद्ध हो सकता हूं। यह वास्तव में अच्छी तरह से काम करता है और आप एक Sandcastle सहायता फ़ाइल बिल्डर परियोजना के भीतर किसी भी संख्या में असेंबली दस्तावेज कर सकते हैं। सिद्धांत रूप में, आपके पास बिल्डर प्रोजेक्ट हो सकता है और प्रत्येक सी # प्रोजेक्ट के लिए एक दस्तावेज़ उत्पन्न कर सकता है और उसके बाद एक मास्टर बिल्डर प्रोजेक्ट होता है जो सब कुछ दस्तावेज करता है।

Answer 2

यहाँ सैंडकैसल आधारित नेट प्रलेखन के लिए कुछ उपयोगी लिंक कर रहे हैं:

Tutorial on Sandcastle

Sandcastle Help File Builder (SHFB)
Tutorial on SHFB

Web Project Documentation
Tutorial on how to document Web Projects (अधिक मैनुअल और मैं पुरानी मानना ​​है कि पिछले दिया लिंक)

MSDN reference for XML Documentation

Answer 3

डॉक्टर परियोजना अधिक पॉलिश दस्तावेज़ बनाती है - जब यह काम करती है - जो हर समय नहीं होती है। यह एक बहुत अधिक flakey उत्पाद है।

Sandcastle सहायता फ़ाइल निर्माता ठोस है और काम पूरा हो जाता है।

Answer 4

मैंने डॉकप्रोजेक्ट का उपयोग नहीं किया है, लेकिन यह एक उत्पाद की तरह लगता है जिसमें सैंडकासल की तुलना में क्षमताएं हैं।

मैंने Sandcastle का उपयोग किया है और मुझे यह एक प्रभावी टूल मिल गया है। अन्य लोगों ने यहां उल्लेख किया है कि आपको एक अच्छा फ्रंट-एंड देने के लिए आपको Sandcastle Help File Builder (SHFB) की भी आवश्यकता है। इसके अलावा, आपको Sandcastle इंजन में प्रस्तुति-परत पैच के लिए Sandcastle Styles की आवश्यकता है। 2010 के मध्य में इन सभी तीनों घटकों की एक नई रिलीज थी, लेकिन 2008 की रिलीज से मैं फ़ायरफ़ॉक्स 3.6 में प्रतिपादन दोष के कारण अपग्रेडिंग कर रहा हूं (इस defect report की 2010.09.06 प्रविष्टि में दस्तावेज)।

मैंने उस समस्या का वर्णन करने वाले प्लेटफार्म के साथ अपने अनुभव को पूरी तरह से दस्तावेज किया है और आपको एक साफ, पेशेवर दस्तावेज सेट तैयार करने के लिए विचार करने की आवश्यकता हो सकती है। मेरा आलेख "Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code" सितंबर 2010 में Simple-Talk.com पर प्रकाशित हुआ था; यह आपको कुछ समय, प्रयास और पीड़ा बचा सकता है :-)।