Option.HelpName Свойство

Определение

Пространство имен:

System.CommandLine

Сборка:

System.CommandLine.dll

Пакет:

System.CommandLine v3.0.0-preview.1.26104.118

Исходный код:

Option.cs

Возвращает или задает имя заполнителя, отображаемое в справке по использованию для значения параметра. Значение будет упаковано в угловые скобки (< и >).

public:
 property System::String ^ HelpName { System::String ^ get(); void set(System::String ^ value); };

public string? HelpName { get; set; }

member this.HelpName : string with get, set

Public Property HelpName As String

Значение свойства

String

Имя, отображаемое в качестве заполнителя для значения параметра.

Примеры

В справке по использованию будет отображаться параметр с параметром >. Если HelpName значение не задано, выходные данные справки будут отображаться: --option <option>

Комментарии

Если nullпараметр будет использоваться, Name при этом будут удалены ведущие дефисы и косая черта.