एपीआई दस्तावेज़ीकरण में .NET एक्सएमएल टिप्पणी

क्या विजुअल स्टूडियो एक्सएमएल आउटपुट से एमएसडीएन-स्टाइल दस्तावेज तैयार करने का कोई आसान तरीका है?
मैं इसके लिए एक अच्छा xslt स्थापित करने के लिए पर्याप्त धैर्यवान नहीं हूं क्योंकि मुझे पता है कि मैं इस पुल को पार करने वाला पहला व्यक्ति नहीं हूं।

इसके अलावा, मैंने हाल ही में sandcastle स्थापित करने की कोशिश की, लेकिन यह वास्तव में मेरी आंखों को पार किया। या तो मैं इस प्रक्रिया में कुछ महत्वपूर्ण याद कर रहा था या यह भी शामिल है।

मैं किसी को जानता हूं कि वास्तव में एक अच्छा मृत-सरल समाधान है।

मैं यहां दोहरा रहा हूं क्योंकि मुझे लगता है कि मेरे प्रारूपण ने पैराग्राफ को पढ़ने के लिए आमंत्रित नहीं किया है:

मैंने sandcastle को आज़मा दिया लेकिन इसे स्थापित करने में वास्तव में कठिन समय था।   जो वास्तव में मेरे मन में है वह कुछ आसान है।

यही है, जब तक कि मैं सिर्फ sandcastle प्रक्रिया को समझ में नहीं आता। ऐसा लगता है कि टेस्टर्स के साथ काम करने के लिए कुछ अच्छा उत्पादन करने के लिए मुझे अतिरिक्त सामान की भयानक लग रही थी।

0
जोड़ा संपादित
विचारों: 1

6 उत्तर

यह सरल 5 चरण आलेख और आप बहुत अधिक कर रहे हैं। एक बोनस के रूप में आप Html सहायता 2.x फ़ाइलों को देखने के लिए H2Viewer का उपयोग कर सकते हैं।

0
जोड़ा

Sandcastle पर एक नज़र डालें, जो वास्तव में ऐसा करता है। यह वहां के अधिक सरल समाधानों में से एक है, और यह पसंद का टूल कम या कम है, इसलिए लंबे समय तक, यदि आप सेटअप के दौरान आपको किन मुद्दों का सामना करना पड़ा है, तो हम आपको Sandcastle सेट अप करने में मदद कर सकते हैं?

0
जोड़ा

मैंने बस फिर से Sandcastle स्थापित किया है। इसे स्थापित करने का प्रयास करें (मई 2008 रिलीज) और SandcastleGui.exe या कुछ इसी तरह की खोज करें (यह उदाहरण फ़ोल्डर में है या तो)।

असेंबली जोड़ें पर क्लिक करें और अपनी असेंबली या असेंबली जोड़ें, किसी भी .xml दस्तावेज़ीकरण फ़ाइलों को जोड़ें (यदि आपने उस विकल्प को सक्षम किया है तो संकलक द्वारा उत्पन्न किए गए) और फिर बिल्ड करें।

इसमें कुछ समय लगेगा, लेकिन परिणाम होगा प्रयास के लायक होंगे। यह वास्तव में एमएसडीएन से सामान देखेगा, इसलिए आपके परिणामी दस्तावेज में सिस्टम विरासत भी सिस्टम के नीचे होगा। एमएसडीएन और सामान के लिंक के साथ संपर्क करें।

Sandcastle पहले थोड़ा जटिल लगता है, खासकर जब आप इसे स्वचालित निर्माण में उपयोग करना चाहते हैं, लेकिन मुझे पूरा यकीन है कि यह प्रयास के लायक होगा।

Sandcastle सहायता फ़ाइल बिल्डर पर भी एक नज़र डालें, यह इसके लिए कुछ और अधिक उन्नत जीयूआई है।

0
जोड़ा

आप Sandcastle की तलाश में हैं

Project Page: Sandcastle Releases

Blog: Sandcastle Blog

NDoc Code Documentation Generator for .NET used to be the tool of choice, but support has all but stopped.

0
जोड़ा
sourceforge.net/projects/ndoc3 आज़माएं
जोड़ा लेखक Muxa, स्रोत

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

Sandcastle सहायता फ़ाइल बिल्डर प्रोजेक्ट में आपका स्वागत है

0
जोड़ा

I use NDoc3

0
जोड़ा