Option.HelpName Vlastnost

Definice

Obor názvů:

System.CommandLine

Sestavení:

System.CommandLine.dll

Balíček:

System.CommandLine v3.0.0-rc.1.26425.128

Zdroj:

Option.cs

Získá nebo nastaví zástupný název zobrazený v nápovědě k použití pro hodnotu možnosti. Hodnota bude zabalena do úhlových závorek (< a >).

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

Hodnota vlastnosti

String

Název, který se má zobrazit jako zástupný symbol pro hodnotu možnosti.

Příklady

V nápovědě k používání se zobrazí možnost s Name--option a HelpName z Value toho jako: --option <Value>. Pokud HelpName není nastavený, zobrazí se výstup nápovědy: --option <option>.

Poznámky

null Pokud Namese použije možnost s úvodními pomlčkami a lomítky odstraněnými.