Visual Studio - تعليقات العلامات الموجزة - المعلمات الاختيارية

Question

عند تحديد تعليقات علامة التلخيص، هل هناك طريقة مع <param> علامة لملاحظة أن المعلمة اختيارية، أي.يمكن للعميل توفير قيمة أو فارغة، مثل: <param name="Mime" optional="true">.

فشل Google في تزويدي بقائمة محددة من السمات أو القيم المسموح بها.

/// <summary>
/// Sets data associated with instance
/// </summary>
/// <param name="Key">The key defining the data</param>
/// <param name="Value">The data</param>
/// <param name="Mime">The mime type of the data (optional)</param>     <----- Mark as optional

شكرًا

Answer 1

لا، لا يمكنك ذلك.السمة الوحيدة التي يتعرف عليها VS هي name, ، مثل هذا:

<param name="FileName" >The filename of the file to be loaded.</param>

الشيء الوحيد الذي يمكنك القيام به هو الضبط تحويل xsl لمستند الإخراج الخاص بك.لكن هذا لن يكون له أي تأثير على Intellisense.

Answer 2

يجب عليك توفير حمل زائد يغفل المعلمة الاختيارية:

/// <summary>
/// Sets data associated with the instance using the default media type.
/// </summary>
/// <param name="key">The key defining the data.</param>
/// <param name="value">The data.</param>
public void SetData(object key, object value)
{
    SetData(key, value, null);
}

/// <summary>
/// Sets data associated with the instance using the specified media type.
/// </summary>
/// <param name="key">The key defining the data.</param>
/// <param name="value">The data.</param>
/// <param name="mime">The media type of the data.</param>
public void SetData(object key, object value, string mime)
{
    ...
}

وبدلاً من ذلك، يمكنك إعلان المعلمة كاختيارية:

/// <summary>
/// Sets data associated with the instance.
/// </summary>
/// <param name="key">The key defining the data.</param>
/// <param name="value">The data.</param>
/// <param name="mime">The media type of the data.</param>
public void SetData(object key, object value, string mime = null)
{
    ...
}

Answer 3

يمكنك استخدام <remarks></remarks> بطاقة شعار.لا توجد علامة خاصة للمعلمات الاختيارية.