Visual Studio: comentarios de etiquetas de resumen: parámetros opcionales
-
27-10-2019 - |
Pregunta
Al especificar comentarios de etiquetas de resumen, ¿hay alguna manera con el <param>
etiqueta para señalar que un parámetro es opcional, es decir.el cliente puede proporcionar un valor o nulo, como por ejemplo: <param name="Mime" optional="true">.
Buscar en Google no me ha proporcionado una lista establecida de atributos o valores permitidos.
/// <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
Gracias
Solución
No, no puedes.El único atributo reconocido por VS es el name
, como eso:
<param name="FileName" >The filename of the file to be loaded.</param>
Lo único que puedes hacer es configurar transformación xsl para su documento de salida.Pero esto no tendrá ningún efecto en Intellisense.
Otros consejos
Debe proporcionar una sobrecarga que omita el parámetro opcional:
/// <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)
{
...
}
Alternativamente, puede declarar el parámetro como opcional:
/// <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)
{
...
}
Puede utilizar la etiqueta <remarks></remarks>
.No existe una etiqueta especial para parámetros opcionales.