CommandLineBuilderExtensions.UseHelp Metoda

Definice

Obor názvů:

System.CommandLine.Builder

Sestavení:

System.CommandLine.dll

Přetížení

UseHelp(CommandLineBuilder, Nullable<Int32>)	Nakonfiguruje aplikaci tak, aby zobrazovala nápovědu, pokud je na příkazovém řádku zadána jedna z následujících možností: -h /h --help -? /?
UseHelp(CommandLineBuilder, String[])	Nakonfiguruje aplikaci tak, aby zobrazovala nápovědu při použití jednoho ze zadaných aliasů možností na příkazovém řádku.
UseHelp(CommandLineBuilder, Action<HelpContext>, Nullable<Int32>)	Nakonfiguruje aplikaci tak, aby zobrazovala nápovědu při použití jednoho ze zadaných aliasů možností na příkazovém řádku.

UseHelp(CommandLineBuilder, Nullable<Int32>)

Nakonfiguruje aplikaci tak, aby zobrazovala nápovědu, pokud je na příkazovém řádku zadána jedna z následujících možností:

-h
/h
--help
-?
/?

public static System.CommandLine.Builder.CommandLineBuilder UseHelp (this System.CommandLine.Builder.CommandLineBuilder builder, int? maxWidth = default);

static member UseHelp : System.CommandLine.Builder.CommandLineBuilder * Nullable<int> -> System.CommandLine.Builder.CommandLineBuilder

<Extension()>
Public Function UseHelp (builder As CommandLineBuilder, Optional maxWidth As Nullable(Of Integer) = Nothing) As CommandLineBuilder

Parametry

builder

CommandLineBuilder

Tvůrce příkazového řádku.

maxWidth

Nullable<Int32>

Maximální šířka výstupu pro výchozí tvůrce nápovědy.

Návraty

CommandLineBuilder

Stejná instance .CommandLineBuilder

UseHelp(CommandLineBuilder, String[])

Nakonfiguruje aplikaci tak, aby zobrazovala nápovědu při použití jednoho ze zadaných aliasů možností na příkazovém řádku.

public:
[System::Runtime::CompilerServices::Extension]
 static System::CommandLine::Builder::CommandLineBuilder ^ UseHelp(System::CommandLine::Builder::CommandLineBuilder ^ builder, ... cli::array <System::String ^> ^ helpAliases);

public static System.CommandLine.Builder.CommandLineBuilder UseHelp (this System.CommandLine.Builder.CommandLineBuilder builder, params string[] helpAliases);

static member UseHelp : System.CommandLine.Builder.CommandLineBuilder * string[] -> System.CommandLine.Builder.CommandLineBuilder

<Extension()>
Public Function UseHelp (builder As CommandLineBuilder, ParamArray helpAliases As String()) As CommandLineBuilder

Parametry

builder

CommandLineBuilder

Tvůrce příkazového řádku.

helpAliases

String[]

Sada aliasů, které lze zadat na příkazovém řádku pro vyžádání nápovědy.

Návraty

CommandLineBuilder

Stejná instance .CommandLineBuilder

Poznámky

Zadané aliasy přepíší výchozí hodnoty.

UseHelp(CommandLineBuilder, Action<HelpContext>, Nullable<Int32>)

Nakonfiguruje aplikaci tak, aby zobrazovala nápovědu při použití jednoho ze zadaných aliasů možností na příkazovém řádku.

public static System.CommandLine.Builder.CommandLineBuilder UseHelp (this System.CommandLine.Builder.CommandLineBuilder builder, Action<System.CommandLine.Help.HelpContext> customize, int? maxWidth = default);

static member UseHelp : System.CommandLine.Builder.CommandLineBuilder * Action<System.CommandLine.Help.HelpContext> * Nullable<int> -> System.CommandLine.Builder.CommandLineBuilder

<Extension()>
Public Function UseHelp (builder As CommandLineBuilder, customize As Action(Of HelpContext), Optional maxWidth As Nullable(Of Integer) = Nothing) As CommandLineBuilder

Parametry

builder

CommandLineBuilder

Tvůrce příkazového řádku.

customize

Action<HelpContext>

Delegát, který bude volána k přizpůsobení nápovědy, pokud je požadována pomoc.

maxWidth

Nullable<Int32>

Maximální šířka výstupu pro výchozí tvůrce nápovědy.

Návraty

CommandLineBuilder

Stejná instance .CommandLineBuilder

Poznámky

Zadané aliasy přepíší výchozí hodnoty.