Visual Studio - Podsumowanie komentarzy znaczników - Opcjonalne parametry

Question

Po określeniu komentarzy podsumowania znaczników, jest ich sposób ze znacznikiem <param>, aby zauważyć, że parametr jest opcjonalny, tj. klient może podać wartość lub wartość zerową, na przykład: <param name="Mime" optional="true">.

Googling nie dostarczył mi listy atrybutów lub dozwolonych wartości.

/// <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 

Dzięki

Answer 1

Nie, nie możesz. Jedynym atrybutem są rozpoznawane przez VS jest name, tak:

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

Jedyne, co można zrobić - jest ustawiony xsl transform dla dokumentu wyjściowego. Ale nie wpłynie to na IntelliSense.

Answer 2

Można użyć <remarks></remarks> tag. Nie istnieje specjalny znacznik dla opcjonalnych parametrów.

Answer 3

Należy dostarczyć przeciążenie że pomija opcjonalny parametr:

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

Alternatywnie, można zadeklarować parametr jako opcjonalne:

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