एक्सएमएल दस्तावेज में रेंडरिंग स्थिरांक?

Question

2 निजी consts और एक सार्वजनिक विधि है:

private const byte _minAge = 24; 
private const byte _maxAge = 29; 

public bool IsInAgeRange() { ... } 

मैं एक्सएमएल प्रलेखन द्वारा जोड़ा जा रहा है, और यह सबसे ज्यादा पसंद करता है, तो मेरे कोड के उपयोगकर्ताओं IntelliSense में यह पढ़ सकता होगा: Checks whether the age is within the allowed range (between 24 and 29).

मेरा प्रश्न है : क्या मेरे एक्सएमएल दस्तावेज में मेरे कॉन्स को प्रस्तुत करने का कोई तरीका है?

---

विकल्प मैं ले कर आए हैं कर रहे हैं:

1. आप दस्तावेज में 24 और 29 लिखने (वास्तविक मूल्यों को निर्भरता का अभाव है)
2. consts सार्वजनिक करें और <see cref="MinAge"> जोड़ने और <see cref="MaxAge"> (encapsulation को कम करता है और दस्तावेज़ीकरण को कम जानकारीपूर्ण बनाता है)

Answer 1

मुझे नहीं लगता कि टी के वास्तविक मूल्य को लिखने का कोई तरीका है वह _minAge और दस्तावेज में _maxAge स्थिरांक लेकिन आप इस प्रकार <see> टैग का उपयोग कर उन्हें का उल्लेख कर सकते:

/// <summary> 
/// Checks whether the age is within the allowed range (between <see cref="_minAge" /> and <see cref="_maxAge" />). 
/// </summary> 

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