في مستند XML، هل يمكنني إدراج مرجع لمجموعة طرق؟كيف؟

Question

في C#، يمكنني إرفاق وثائق للخصائص والأساليب والأحداث وما إلى ذلك ، مباشرة في الكود باستخدام تعليقات وثائق XML.

أعرف كيفية إدراج مرجع لطريقة معينة:

<see cref="MethodName(TypeForArg1, TypeForArg2..)"/>

هل هناك طريقة لإدراج إشارة إلى أ مجموعة الطريقة؟حيث لدي عدة حمولات زائدة لنفس اسم الطريقة ...

حاولت

<see cref="M:MethodName"/>

..ولكن ذلك لم ينجح.

يحرر: صدم

Answer 1

على ما يبدو لا توجد طريقة للقيام بذلك.

Answer 2

يبدو أنه تم إصلاح هذا الأمر على الأقل في Visual Studio 2012:

<see cref="MethodName"/>

سوف يولد تحذيرا:

مرجع غامض في سمة cref:"اسم الأسلوب".بافتراض "..."، ولكن من الممكن أيضًا أن تتطابق مع الأحمال الزائدة الأخرى بما في ذلك "...".

لكن إضافة M: في المقدمة تخلص من التحذير:

<see cref="M:MethodName"/>

Answer 3

وهذا مدعوم الآن في Sandcastle.

للإشارة إلى مجموعة أسلوب، مطلوب بناء الجملة التالي:

/// <summary>
/// Reference to a method group with two items:
/// <see cref="O:Full.Declaring.Namespace.TypeName.Foo"/>
/// </summary>
void Foo() { }
void Foo(int x) { }

لاحظ أن بناء الجملة هذا لا يزال به بعض القيود، كما هو موضح طلب ميزة لغة C# هذا.

• لم يتم التحقق من صحة بناء الجملة أثناء الإنشاء.لا يتم الإبلاغ عن الأخطاء التي تحدث أثناء الكتابة حتى إذا/عندما يقوم Sandcastle Help File Builder بمعالجة التعليقات.
• بناء الجملة فقط يعمل إذا كان هناك أكثر من طريقة بنفس الاسم.
• لا يوجد أي تمييز لبناء الجملة أو دعم المحرر لبناء الجملة هذا.