Visual Studio - Zusammenfassung Tag-Kommentare - Optionale Parameter

Question

Wenn Sie Kommentare zu Zusammenfassungs-Tags angeben, können Sie mit dem Tag <param> feststellen, dass ein Parameter optional ist, d. h.Der Client kann einen Wert oder eine Null angeben, z. B.: <param name="Mime" optional="true">.

Googeln hat mir keine festgelegte Liste von Attributen oder zulässigen Werten zur Verfügung gestellt.

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

Danke

Answer 1

Nein, das kannst du nicht.Das einzige Attribut, das von VS erkannt wird, ist der name wie folgt:

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

Sie können nur die xsl-Transformation für Ihr Ausgabedokument.Dies hat jedoch keine Auswirkungen auf Intellisense.

Answer 2

Sie sollten eine Überladung bereitstellen, bei der der optionale Parameter weggelassen wird:

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

Alternativ können Sie den Parameter als optional deklarieren:

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

Sie können das <remarks></remarks>-Tag verwenden.Es gibt kein spezielles Tag für optionale Parameter.