2011-11-30 24 views
8

मैंने निर्देशित जीयूआई स्थापना के साथ पैच के साथ सैंडकासल की कोशिश की है, लेकिन जब तक कि मैं कुछ गलत नहीं कर रहा हूं, यह मूल रूप से एफ # कोड को दस्तावेज करने के लिए अनुपयुक्त है (भले ही यह सी # के लिए वास्तव में अच्छा काम करेगा)। शायद यह दूसरों के लिए काम करता है, इस मामले में मैं एक संक्षिप्त पूर्ण उदाहरण के लिए बहुत आभारी हूं कि मैं शुरू कर सकता हूं। बहुत धन्यवाद।एफ # कोड दस्तावेज करने का सबसे अच्छा तरीका क्या है?

मुझे Sandcastle doesn't output everything from a F# assembly के बारे में पता है, लेकिन वहां संदर्भित परियोजना अभी तक प्राइम टाइम के लिए तैयार नहीं है।

निश्चित रूप से ऐसा कुछ होना चाहिए जो विश्वसनीय रूप से काम करता है और "पर्याप्त पर्याप्त" है? किसी भी सुझाव के लिए बहुत धन्यवाद।

संपादित करें: उत्तर देने वाले सभी लोगों के लिए बहुत धन्यवाद। ब्रायन का जवाब जो चाहता था उससे निकटतम था, इसलिए मैं इसे स्वीकार करूंगा। हालांकि, नतीजा यह है कि ऐसा कोई समाधान नहीं दिखता है जो एफ # के अनुकूल है और यह विश्वसनीय रूप से काम करता है। मैं अब के लिए पाठ्य टिप्पणियों के साथ रहना होगा।

मुझे उम्मीद है कि FsHtmlDoc.exe किसी बिंदु पर काम करना शुरू कर देगा। जबकि मैं इस बात से इनकार नहीं कर सकता कि यह पहले से ही काम करता है और मैंने इसे सही तरीके से उपयोग नहीं किया है, यह बताता है कि मैं इसे खोजने के लिए अकेला नहीं हूं, यह अभी तक सही नहीं है।

उत्तर

3

मुझे सैंडकैसल के बारे में कुछ भी नहीं पता है, लेकिन ध्यान दें कि सी # में, एफ # में आप ट्रिपल-स्लैश टिप्पणियों का उपयोग कर सकते हैं, और वे XML दस्तावेज़ फ़ाइल में आउटपुट होंगे जो संकलक आउटपुट (वीएस में, प्रोजेक्ट गुणों पर) पेज,, टैब का निर्माण 'Xml प्रलेखन फ़ाइल' चेकबॉक्स जाँच; कमांड लाइन पर, fsc.exe करने के लिए --doc तर्क का उपयोग करें)

इसके अलावा, PowerPack में FsHtmlDoc.exe देखते हैं।।

+0

बहुत धन्यवाद। दुर्भाग्यवश, मुझे लगता है कि http://fsharppowerpack.codeplex.com/workitem/6375# (हालांकि यह बहुत आसानी से हो सकता है कि दोनों और जो भी बग की रिपोर्ट करता है वह कुछ गलत करता है) – user1002059

2

तुम भी Focco

एक अच्छा एचटीएमएल आधारित प्रलेखन पैदा करता है पर देखने के कर सकते हैं। उदाहरण के लिए here देखें:

+0

बहुत धन्यवाद। मैं अभी भी इसका उपयोग कर सकता हूं, हालांकि मैं वास्तव में ऐसा कुछ ढूंढने की उम्मीद कर रहा था जो प्रतिबिंब का उपयोग करते हुए तर्क प्रकार दस्तावेज करता है। – user1002059

1

आप IntelliFactory से ApiStack भी देख सकते हैं। मुझे एहसास है कि फोकको के पास एक बहुत ही अलग दृष्टिकोण की आवश्यकता है यदि आपके पास पहले से ही बहुत से मानक एक्सएमएल दस्तावेज़ टिप्पणियां हैं।

+0

बहुत धन्यवाद। दुर्भाग्यवश, मुझे स्रोत कोड प्रकाशित करने की अनुमति नहीं है। – user1002059

0

मैं इसे इस्तेमाल नहीं किया है, लेकिन यह docu को आज़माने की लायक हो सकती है ...