का उपयोग कर डब्ल्यूसीएफ दस्तावेज जेनरेट करें मैं SandCastle का उपयोग कर डब्ल्यूसीएफ सेवा के लिए बाहरी दस्तावेज उत्पन्न करने की कोशिश कर रहा हूं। सैंडकास्टल को डब्ल्यूसीएफ विशेषताओं जैसे कि ServiceContract का उपयोग करने के लिए विधानसभा में उनके नामों के बजाय कार्यों और संस्थाओं का नामकरण करने के लिए कैसे कह सकता हूं?SandCastle
ठीक है, तो आपके प्रश्न का सीधा जवाब नहीं होगा, लेकिन शायद यह किसी भी तरह से मदद करेगा।
यदि आप कह रहे हैं कि आप "बाहरी सेवा प्रलेखन" बनाना चाहते हैं, तो बाहरी दस्तावेज़ शायद वास्तव में .NET डेवलपर्स के लिए नहीं है और आप यह भी कार्यान्वयन विवरण (अनिवार्य रूप से) दिखाना नहीं चाहते हैं। तो सामान्य एपीआई शैली दस्तावेज वैसे भी उपयुक्त नहीं हो सकता है।
उस एपीआई स्टाइल दस्तावेज़ के बगल में सैंडकासल भी "वैचारिक दस्तावेज" कहलाता है। निश्चित रूप से एक निश्चित एक्सएमएल बोली में, जो मूल रूप से "मुफ़्त पाठ" है। मैं बाद में वापस आऊंगा।
ठीक है, आप पहली बार अपने सेवा इंटरफेस के लिए एक WSDL फ़ाइल (आमतौर पर सेवा के यूआरआई को ?WSDL जोड़कर या आपकी सेवा विधानसभा है, जो बेहतर एक स्वचालित निर्माण के दौरान अनुकूल है पर SVCUTIL.EXE का उपयोग करके) उत्पन्न होगा।
फिर कठिन हिस्सा आता है। आपको कुछ ऐसा बनाना होगा जो डब्लूएसडीएल को MAML दस्तावेजों में परिवर्तित कर देगा (एक एक्सएमएल स्टाइलशीट दिमाग में आता है)। एमएएमएल (माइक्रोसॉफ्ट असिस्टेंट मार्कअप लैंग्वेज) वास्तव में सैंडकैसल द्वारा उपयोग किए जाने वाले कोर प्रारूप को कहने के लिए है।
मुझे लगता है कि आपके सर्वोत्तम शर्त को Sandcastle Helpfile Builder का उपयोग करना होगा ताकि इन फ़ाइलों में से एक सीएचएम, एचटीएमएल-पेज या जो कुछ भी हो सके।
असल में, एक बार आपके पास एमएएमएल दस्तावेज हो जाने के बाद, आप "मानक" Sandcastle टूल श्रृंखला में वापस आ गए हैं।
मुझे पता है कि कुछ काम की तरह लगता है, और शायद यह है। मैंने अतीत में कुछ तुलनीय किया है, जहां मैं संदर्भ दस्तावेज उत्पन्न करने के लिए टेबल, प्रक्रियाओं इत्यादि के लिए एमएएमएल दस्तावेज़ जेनरेट करने के लिए एसक्यूएल सर्वर डेटाबेस से पूछताछ करने के लिए एसएमओ का उपयोग करूंगा। असल में, यह काफी अच्छी तरह से काम किया और अंत में प्रयास बहुत बुरा नहीं था।
वैसे भी, मुझे लगता है कि प्रश्न के मामले में देखें वहाँ वास्तव में एक "शेल्फ से" समाधान :-)
मैं कुछ 'शेल्फ से' सॉफ्टवेयर अपने आप को कि DLL से बाहर प्रलेखन उत्पन्न करता है लेखन समाप्त हो गया मौजूद रहेंगे और कोड में XMLDoc टिप्पणी। मैं यह देखने के लिए अपने नियोक्ता से परामर्श करूंगा कि मैं इसे गिटहब कर सकता हूं या नहीं। –
क्या आपको कोड पीढ़ी के लिए कोड प्रकाशित करने की अनुमति मिली है? –