वीएस 2010 सी # एक्सएमएल दस्तावेज

Question

से एचटीएमएल/सहायता फाइलें जेनरेट करें मैं अपने वीएस -2010 एक्सएमएल दस्तावेज से एचटीएमएल/हेल्प फाइल बनाने के लिए एक अच्छा टूल ढूंढ रहा हूं। मैं, इस तरह के

• .Net documentation tool
• VSDocman

मुझे यकीन है कि वहाँ और अधिक कर रहे हैं के रूप में कर रहा हूँ, कुछ व्यावसायिक उपकरण पाया है मैं सिर्फ इन दो उदाहरण के रूप में सूचीबद्ध करते हैं। XML को HTML दस्तावेज़ में कनवर्ट करने के लिए आस-पास सरल XSLT स्टाइलशीट भी हैं।

आप क्या उपयोग कर रहे हैं, उदा। रूपांतरण करने के लिए एक मुफ्त उपकरण है, शायद ऐड-इन के रूप में। बस स्पष्ट करने के लिए, मूल रूप से मैं उपकरणों के दो प्रकार पाया है:

अलग लक्ष्य स्वरूपों में एक्सएमएल प्रलेखन फ़ाइल में परिवर्तित करने वाले
1. , यह मैं के लिए क्या देख रहा हूँ।
2. उपकरण कोड में XML दस्तावेज़ उत्पन्न करने में मेरी सहायता करने वाले टूल। यह नहीं है (!) जो मैं खोज रहा हूं।

आपकी सहायता के लिए धन्यवाद।

---

सैंडकासल/एसएचएफबी कॉम्बो महान काम करता है। सभी सहायकों का धन्यवाद।

कुछ टिप्पणी:

1. NDoc पुराना हो रहा है, पिछले अद्यतन 2005 से यही कारण है कि मैं इस को छोड़ दिया है है कर रहे हैं।
2. एक समान धागा, भी बहुत विस्तृत, यहां पाया जा सकता है: How to turn C# Xml Doc-Comments into something useful? संकेत के लिए धन्यवाद! http://sandcastle.codeplex.com/
3. आदेश MsHelp2 उत्पन्न करने के लिए मैं 2008 वी.एस. hscomp.exe युक्त एसडीके स्थापित करने के लिए किया था:
4. कुछ सूत्रों सैंडकैसल, नवीनतम संस्करण के लिए मैं पाया है यहाँ स्थित है रहे हैं। एक संस्करण 1.0 और 1.1 है, जहां तक ​​मैं इसे संस्करण 1.0 में समझ सकता हूं संकलक शामिल है। कुछ विवरणों के लिए Helixsoft और Social MSDN देखें।
5. मेरे मामले में जेनरेट किया गया WebHelp क्रोम के साथ सही तरीके से काम नहीं करता है। यह हमेशा index.html पृष्ठ को पुनः लोड करता है।
6. topic here दिखाता है कि नामस्थान इंफोस को sandcastle दस्तावेज़ में कैसे जोड़ना है।
7. नवंबर 2012 तक अपडेट करें: छोटी परियोजनाओं के लिए मैं Doxygen का उपयोग कर रहा हूं - मुझे इसे कॉन्फ़िगर करने में थोड़ा आसान लगता है।

Answer 1

हम सहायता परियोजनाओं के प्रबंधन के लिए उपयोगकर्ता इंटरफ़ेस के रूप में Sandcastle सहायता फ़ाइल बिल्डर के लिए Sandcastle का उपयोग कर रहे हैं &। मेरी राय में सैंडकैसल और एसएचएफबी की सुंदरता यह है कि "औसत" स्रोत कोड प्रलेखन के बगल में, आप प्रोग्राम की आर्किटेक्चर जैसी अतिरिक्त जानकारी जोड़ सकते हैं, पैटर्न का पालन किया जाना चाहिए या आपके प्रोजेक्ट के लिए कोई अतिरिक्त अवधारणात्मक सामग्री जो बंधी नहीं है सीधे अपने कार्यक्रम में एक कक्षा में। यह माइक्रोसॉफ्ट ऑथरिंग स्कीमा की मदद से अतिरिक्त एक्सएमएल फाइलें बनाकर किया जा सकता है (दृश्य स्टूडियो के साथ एक्सएमएल फाइल के रूप में संपादित किया जा सकता है और इसके लिए स्कीमा उपलब्ध है)। दस्तावेज की तरह एमएसडीएन बनाने के लिए उन दोनों उपकरणों के साथ शुरू करना बहुत आसान है।

बहुत समय पहले मैंने डॉकबुक की कोशिश की जो तकनीकी पक्ष पर लगभग समान है (जानकारी युक्त xml फाइलें और xslt फ़ाइलों को विभिन्न आउटपुट प्रकारों में बदलने के लिए)। लेकिन यह हमारे लिए कोई विकल्प नहीं था, क्योंकि वहां कोई बदलाव नहीं है जो दृश्य स्टूडियो जेनरेट किए गए एक्सएमएल दस्तावेज का उपयोग कर सकता है (साथ ही वैचारिक सामग्री का परिवर्तन हमारे लिए बहुत दर्दनाक था)।

Answer 2

दो और मुफ़्त उपकरण है कि XML टिप्पणियों से दस्तावेज की निर्माण की अनुमति:

• NDoc
• Sandcastle

Answer 3

सैंडकैसल + SHFB एक महान कॉम्बो कर रहे हैं।नि: शुल्क और एचटीएमएल, सीएम, आदि उत्पन्न करता है