سؤال

إذا كان لدي هاتين الطريقتين

public Foo Get(string bar) { ... }
public Foo Get(int bar) { ... }

واكتب هذه الوثائق XML هذه على طريقة مختلفة

/// <summary>
/// Has a close relation to the <see cref="Get"/> methods.
/// </summary>

أحصل على squiggly الأزرق تحت Get, ، قائلا إنها مرجع غامض "الحصول عليه". وبعد وهذا صحيح، لكنني أريد أن أشير إلى حد سواء. ما هي الطريقة الصحيحة للقيام بذلك؟ أو يجب علي أن أشير فقط إلى طريقة واحدة الزائد؟

هل كانت مفيدة؟

المحلول

يحاول

/// Has a close relation to the <see cref="Get(string)"/>  
/// and <see cref="Get(int)" /> methods.

قد تحتاج إلى أسماء طبي كاملة ولكن يجب أن يساعد Intellisense بمجرد وضع الأقواس الأول في.

امل ان يساعد،

دان

نصائح أخرى

إليك إجابة محدثة على هذا السؤال القديم. لست متأكدا عندما أصبح هذا صحيحا لأنه لا يوجد الكثير من الوثائق هناك. إذا كنت بادئة cref سمة مع "o:..." مثلما في "o:myMethod()" سوف يرتبط بمقطع الحمل الزائد وتغطية جميع الزائد من هذه الطريقة. استخدام مثال إجابة Daniel Elliott:

/// Has a close relation to the <see cref="o:Get()"/> methods.  

سيؤدي ذلك أيضا إلى إزالة التحذيرات من IntelliSense / Resharper عن المراجع الغامضة.

مرخصة بموجب: CC-BY-SA مع الإسناد
لا تنتمي إلى StackOverflow
scroll top