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 transform для вашего выходного документа. Но это не повлияет на 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>.Не существует специального тега для необязательных параметров.