सी # एक्सएमएल दस्तावेज में एक सामान्य प्रकार के सामान्य प्रकार का जिक्र करते हुए?

Question

एक अनुमानित सहायक वर्ग के लिए कुछ XML दस्तावेज़ लिखना। लेकिन मुझे पता नहीं लगा सकता कि मैं एक वाक्यविन्यास त्रुटि प्राप्त किए बिना Expression<Func<T, bool>> का संदर्भ ले सकता हूं। क्या यह भी संभव है? मैं इस की कोशिश की है:

<see cref="Expression{Func{T, bool}}"/> 

लेकिन मैं {T, bool}} के तहत एक लाल टेढ़ी-मेढ़ी रेखा मिलता है। यह हालांकि काम करता है:

<see cref="Expression{TDelegate}"/> 

किसी के पास कोई सुराग है?

---

अद्यतन:

जवाब यह है कि दिया गया था (और मैं स्वीकार किए जाते हैं) प्रतीत होता है काम किया है। लेकिन अब मुझे हल करने में सक्षम नहीं होने वाली चीजों के बारे में बहुत सारी चेतावनियां मिलनी शुरू हो गई हैं। मेरे पास ExpressionBuilder<T> नामक एक कक्षा है जो Expression<Func<T, bool>> के साथ काम करती है। तो मैं निश्चित रूप से मेरी एक्सएमएल टिप्पणियों में उल्लेख करना चाहता हूं।

<see cref="Expression&lt;Func&lt;T, Boolean&gt;&gt;"/> 
<see cref="Expression{Func{T, Boolean}}"/> 

लेकिन न तो काम:

मैं दोनों संस्करणों है कि मैं के बारे में पता करने की कोशिश की है। (और पिछले एक पर, ReSharper एक नीले रंग की टेढ़ी-मेढ़ी तहत {T,Boolean}} मैं संकलन के तहत दो चेतावनी मिल डालता है हर जगह मैं इसे इस्तेमाल किया है जो कहता है कि:

1. ', ऐसा' पर एक्सएमएल टिप्पणी विशेषता 'अभिव्यक्ति cref है> 'है कि हल नहीं किया जा सकता है
2. प्रकार पैरामीटर घोषणा एक पहचानकर्ता एक प्रकार नहीं होना चाहिए। यह भी देखें त्रुटि CS0081।

कहीं मैं Range<Nullable<DateTime>> का उल्लेख करने की कोशिश की एक ही मुद्दा है (Range<DateTime?> या तो काम नहीं किया। {} और < > के साथ दोनों)

क्या मुझे इन प्रकार के जेनेरिकों का उल्लेख नहीं करना चाहिए?

Answer 1

एक्सएमएल दस्तावेज में जेनेरिक के जेनेरिक को संदर्भित करने का कोई तरीका नहीं है, क्योंकि वास्तव में, किसी विशिष्ट प्रकार के जेनेरिक को संदर्भित करने का कोई तरीका नहीं है।

आप <see cref="IEnumerable{Int32}" /> लिखते हैं, संकलक बस "Int32" प्रकार पैरामीटर नाम, नहीं प्रकार तर्क के रूप में उपयोग करता है:

लासे वी Karlsen के answer यह मेरे लिए क्लिक बना दिया। लेखन <see cref="IEnumerable{HelloWorld}" /> भी काम करेगा। यह समझ में आता है क्योंकि एमएसडीएन में "इंट्यूमेरेबल ऑफ इंट" के लिए कोई विशिष्ट पृष्ठ नहीं है जो आपके दस्तावेज़ से लिंक हो सकता है।

अपने वर्ग के दस्तावेज करने के लिए ठीक से, मुझे लगता है कि आप की तरह कुछ लिखने के लिए होगा:

<summary> 
Returns an <see cref="IEnumerable{T}" /> of <see cref="KeyValuePair{T,U}" /> 
of <see cref="String" />, <see cref="Int32" />. 
</summary> 

मैं आप पाठ की तरह उम्मीद है।

Answer 2

// Use "&lt;" instead of "<" symbol and "&gt;" instead of ">" symbol. 

// Sample: 

<see cref="Expression&lt;Func&lt;T, bool&gt;&gt;"/> 

Answer 3

आप इसे किस लिंक से जोड़ना चाहते हैं?

प्रलेखन में Expression<Func<T>> के रूप में ऐसी कोई चीज़ नहीं है, तो जाहिर है कि इसका एक लिंक काम नहीं करेगा।

आप Expression<TDelegate> से लिंक कर सकते हैं क्योंकि यह मौजूद है।

क्या काम करता है या नहीं, न तो दृश्य स्टूडियो में निम्नलिखित कार्यों के लिए के रूप में 2008/.NET 3.5 मेरे लिए:

/// <see cref="Expression&lt;Func&lt;T&gt;&gt;"/>. 
/// <see cref="Expression{Func{T}}"/>. 

लेकिन यह काम करता है:

/// <see cref="Expression{T}"/>. 

तो जाहिरा तौर पर

सामान्य प्रकार पैरामीटर की घोषणा में एक जैसा नहीं है।

Answer 4

मैं अब इसमें भाग रहा हूं, क्योंकि मेरे पास एक ऐसा फ़ंक्शन है जो List<List<byte>> देता है। हाँ, यह बदसूरत है, लेकिन मैंने इसे नहीं लिखा था। मानक अस्वीकरण, मुझे पता है।

वैसे भी, वी.एस. 2017 आर # परम 2017.1, इस दस्तावेज़ के टिप्पणी के साथ ...

में

<returns><see cref="List{List{Byte}}" /> of split frames</returns> 

... मेरे एक सिंटैक्स त्रुटि देता है। बहरहाल, यह ...

<returns><see><cref>List{List{byte}}</cref></see> of split frames</returns>

... नहीं करता है। Eeenteresting।

अभी भी बदसूरत? हाँ।

बदसूरत के रूप में? मुझे लगता है कि यह < और > का उपयोग करने से कम भयानक है ....

Answer 5

खाली दृश्य तत्व (<see cref="..." />) का उपयोग न करें। इसके बजाए, देखें तत्व

<see cref="IEnumerable{T}">IEnumerable</see>&lt;<see cref="..."/>$gt;