c# - Visual Studio - 概要タグのコメント - オプションのパラメーター

Question

概要タグのコメントを指定する場合、<param>タグを使用してパラメータがオプションであることを示す方法はありますか? クライアントは、次のような値または null を指定できます。<param name="Mime" optional="true">.

グーグルは、属性または許可された値のセットリストを提供できませんでした.

/// <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>。オプションのパラメーター用の特別なタグは存在しません。