Sandcastle - अभी भी उपयोग करने के लिए सही बात है? या क्या विकल्प हैं?

Question

मैं बस सोच रहा हूँ - Sandcastle के अंतिम जारी कर सकता है 2008 से है, और यह अभी भी पूर्व रिलीज सॉफ्टवेयर/सीटीपी के रूप में सूचीबद्ध है और यह भी, अब और लाइसेंस प्राप्त नहीं कर रहा है के रूप में EULA specifially का कहना है:

2। सावधि। इस समझौते की अवधि 1 सितंबर, 2007 तक या सॉफ्टवेयर की व्यावसायिक रिलीज, जो भी पहले हो, तक है।

जैसा कि Sandcastle बल्कि "भारी" है, मुझे आश्चर्य है कि यह अभी भी उपयोग करने के लिए सही बात है, या यदि XmlDoc दस्तावेज़ीकरण बनाने के विकल्प हैं? (विकल्प = कुछ मैं अपने निर्माण से कम से कम HTML उत्पन्न करने के लिए चला सकता हूं, अधिमानतः पीडीएफ भी)।

Answer 1

कोई भी दस्तावेज, हाल ही में एक परियोजना जेम्स ग्रेगरी द्वारा शुरू की, देव नेतृत्व उल्लेख FluentNHibernate पर ।

• Announcement
• The Docu website

यह एक बहुत ही सरल और प्रयोग करने में आसान टूल है एचटीएमएल प्रलेखन एक ला rdoc उत्पन्न करता है। आप टेम्पलेट को आसानी से संशोधित कर सकते हैं क्योंकि डॉकू दृश्य इंजन के रूप में Spark का उपयोग करता है।

यहाँ FluentNHibernate documentation दस्तावेज के साथ बनाया गया है।

Answer 2

जहां तक ​​मुझे पता है, Sandcastle अभी भी एक वैध विकल्प है। मैंने हाल ही में इसे कई बार इस्तेमाल किया है और इसमें कोई समस्या नहीं है। आप MSDN पर इस पेज की जाँच और अन्य अच्छे विकल्प के लिए 'प्रलेखन' अनुभाग तक नीचे स्क्रॉल कर सकते हैं:

C# Programming Tools

Answer 3

माइक्रोसॉफ्ट सैंडकैसल अभी भी जाने के लिए सही तरीके से निश्चित रूप से है। मुख्य विकल्प (जो Sandcastle के फीचर सेट के करीब कुछ भी प्रदान करता है) NDoc है, लेकिन इसकी आखिरी रिलीज जनवरी 2005 में बहुत पुरानी है!

हालांकि यह अभी भी तकनीकी रूप से (देर से) प्री-रिलीज चरण में है, लेकिन वास्तव में यह काफी स्थिर उपकरण है। Sandcastle Styles प्रोजेक्ट के हिस्से के रूप में कोडप्लेक्स पर उपलब्ध पैच द्वारा छोटी संख्या में बग तय किए गए हैं। इसके लिए एक शानदार जीयूआई भी है, अर्थात् Sandcastle Help File Builder।

हालांकि मुझे Sandcastle के भविष्य के विकास के बारे में निश्चित नहीं है। मेरा मानना ​​है कि ऐसा लगता है कि माइक्रोसॉफ्ट किसी भी समय काम/विस्तार जारी रखेगा, हालांकि ऐसा कोई प्रतीत नहीं होता है। फिलहाल .NET लाइब्रेरी या एप्लिकेशन के लिए उचित दस्तावेज बनाने के लिए यह एकमात्र सभ्य उपकरण है। बेशक आप छोटी परियोजनाओं/सहायता फ़ाइलों के लिए अक्सर "हल्के वजन" उपकरण का उपयोग कर दूर हो सकते हैं। मैंने जो मुख्य विकल्प देखा है वे दोनों सैंडकैसल के वाणिज्यिक और निम्न दोनों हैं।

हाथ से प्रलेखन जनरेट कर रहा है/कस्टम स्वचालन का उपयोग कर शायद कुछ मामलों में संभव है, लेकिन केवल छोटी परियोजनाओं के लिए (कि विस्तार की संभावना नहीं हैं।)

Answer 4

सैंडकैसल अभी भी एक सही स्थान है। मैंने इसे कई परियोजनाओं के लिए अतीत में इस्तेमाल किया था।

वैसे भी इन पर नज़र पर ले:

• NDoc
• GhostDoc - एक नि: शुल्क दृश्य स्टूडियो एक्सटेंशन

Answer 5

DocProject पर एक नज़र लेने लायक है। यह sandcastle के साथ काम करने के बहुत दर्द दूर ले जाता है।

Answer 6

मैं इस तो सवाल में कुछ प्रलेखन उपकरणों की एक संक्षिप्त सूची: anyone-using-ndoc-or-a-similar-tool

मुझे लगता है कि सैंडकैसल वर्तमान में सबसे अच्छा खुला स्रोत उपकरण है (.NET परियोजनाओं के दस्तावेजीकरण के लिए), लेकिन वहाँ कई वाणिज्यिक उपकरण हैं, और वे बेहतर प्रदर्शन और अधिक विशेषताओं का प्रस्ताव दे सकते हैं, इसलिए यदि आपके पास उनमें से किसी के लिए बजट है, तो कम से कम मूल्यांकन करना महत्वपूर्ण है कि यह आपके लिए क्या मूल्य ला सकता है।

Answer 7

प्रभावी रूप से सैंडकैसल उपयोग करने के लिए की जरूरत है, के रूप में Noldorin पहले कहा, यह भी सैंडकैसल शैलियाँ उपयोग करने के लिए और सैंडकैसल मदद फ़ाइल बिल्डर (SHFB)। 2010 के मध्य में उन सभी की एक नई रिलीज थी, इसलिए निश्चित रूप से वर्तमान उपकरण हैं।

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

एक और सहायक संसाधन: अक्टूबर 2010 में मैंने one-page wall chart के साथ आलेख का पालन किया जो एसएचएफबी के लिए एक्सएमएल दस्तावेज टिप्पणी लेक्सिकॉन का सारांश देता है।