ValueDescriptionAttribute Class

public class ValueDescriptionAttribute : Attribute

Public Class ValueDescriptionAttribute
	Inherits Attribute

Dim instance As ValueDescriptionAttribute

public ref class ValueDescriptionAttribute : public Attribute

Inheritance

Object    Attribute    ValueDescriptionAttribute

The value description is a short, typically one-word description that indicates the type of value that the user should supply.

If this attribute is not present, it is retrieved from the ParseOptionsDefaultValueDescriptions property. If not found there, the type of the argument is used, applying the NameTransform specified by the ParseOptionsValueDescriptionTransform property or the ParseOptionsAttributeValueDescriptionTransform 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 ParseOptionsDefaultValueDescriptions property.

The value description is used when generating usage help. For example, the usage for an argument named Sample with a value description of String would look like "-Sample <String>".

You can derive from this attribute to use an alternative source for the value description, such as a resource table that can be localized.

Reference