Visual Studio - サマリータグコメント - オプションのパラメータ

Question

サマリータグコメントを指定する場合は、<param>タグを使用するとパラメータがオプションであることに気付くことができます。クライアントは次のような値またはヌルを指定できます。<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 transformを設定することです。しかし、これはIntellisenseには何の影響も与えません。

Answer 2

あなたは<remarks></remarks>タグを使用することができます。オプションのパラメータの特別なタグは存在しません。

Answer 3

あなたは、オプションのパラメータを省略し、過負荷提供する必要があります：

/// <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) 
{ 
    ... 
}