Note
This is not the long description used to describe the purpose of the argument. That can be set
using the DescriptionAttribute attribute.
public string? ValueDescription { get; set; }
Public Property ValueDescription As String
Get
Set
Dim instance As CommandLineArgumentAttribute
Dim value As String
value = instance.ValueDescription
instance.ValueDescription = value
public:
property String^ ValueDescription {
String^ get ();
void set (String^ value);
}
The value description is a short, typically one-word description that indicates the type of value that the user should supply.
If not specified here, it is retrieved from the DefaultValueDescriptions property, and if not found there, the type of the property is used, applying the NameTransform specified by the ValueDescriptionTransform property or the ValueDescriptionTransform property. If this is a multi-value argument, the element type is used. If the type is NullableT, its underlying type is used.
If you want to override the value description for all arguments of a specific type, use the DefaultValueDescriptions property.
The value description is used only when generating usage help. For example, the usage for an argument named Sample with a value description of String would look like "-Sample <String>".