Sandcastle का उपयोग करके दस्तावेज़: <see>

Question

का उपयोग करके enum मान को प्रतिबिंबित करना मैं एक .chm सहायता फ़ाइल उत्पन्न करने के लिए Sandcastle 2.4.10520 और Sandcastle Help फ़ाइल निर्माता 1.8.0 का उपयोग कर रहा हूं।

मेरे प्रलेखन में, मैं <see> टैग का उपयोग कर रहा हूं।

यदि मैं <see cref="NumberStyles"/> जैसे एनम को संदर्भित करने का प्रयास करता हूं तो यह पूरी तरह से काम करता है।

अगर मैं <see cref="NumberStyles.AllowTrailingWhite"/> की तरह एक enum मूल्य मैं प्रलेखन फ़ाइल में एक लिंक मिल उल्लेख करने के लिए प्रयास करते हैं, लेकिन लिंक मुझे एक MSDN Page not found

की ओर जाता है मैं कोई चेतावनी नहीं मिलता है - मेरी xml प्रलेखन सही है।

मैंने देखा है कि एमएसडीएन पेज जो एनम वैल्यू को संदर्भित करते हैं, उनके पास एक पृष्ठ नहीं मिला है। उदाहरण के लिए: UInt64.Parse Method (String, NumberStyles, IFormatProvider)NumberStyles.AllowHexSpecifier को संदर्भित करता है और इससे MSDN Page not found पर जाता है।

क्या मुझे एनम मूल्य के बजाय enum का उल्लेख करना चाहिए?

एनम को संदर्भित करने के लिए मुझे क्या करना चाहिए? क्या यह भी संभव है?

Answer 1

तथ्य यह है कि यह एमएसडीएन पर हो रहा है, यह अच्छी तरह से नहीं है। क्या एनम मानों में एक्सएमएल दस्तावेज है?

यदि मुझे सही याद है, तो एसएचएफबी में सेटिंग्स होनी चाहिए जो आपको उन सदस्यों के लिए प्रलेखन की पीढ़ी को मजबूर करने देगी जिनके पास एक्सएमएल नहीं है - या शायद यह एक सेटिंग है जो आपको उन सदस्यों को बहिष्कृत करने देती है जिनमें XML दस्तावेज़ नहीं है। भले ही, यह सुनिश्चित करने के लिए कि आप enum सदस्यों को इस तरह से बाहर नहीं कर रहे हैं, सेटिंग को एक बार अच्छा लगा दें।

अन्यथा, यह प्रत्येक सदस्य के लिए दस्तावेज़ीकरण उत्पन्न करना चाहिए, और enum मान एक प्रकार के सदस्य हैं जो एक स्थिर या स्थैतिक क्षेत्र के समान होंगे।

संपादित करें: यह कम से कम नई एमएसडीएन साइट पर दिखता है, व्यक्तिगत enum मानों को अपना स्वयं का पृष्ठ नहीं दिया जाता है। उदाहरण के लिए, NumberStyles enum पर एक नज़र डालें। उस स्थिति में, आपके पास enum से जोड़ने से बेहतर विकल्प नहीं हो सकता है।