CommandLineBuilderExtensions.UseHelp Metodo

Definizione

Spazio dei nomi:

System.CommandLine.Builder

Assembly:

System.CommandLine.dll

Overload

UseHelp(CommandLineBuilder, Nullable<Int32>)	Configura l'applicazione per visualizzare la Guida quando viene specificata una delle opzioni seguenti nella riga di comando: -h /h --help -? /?
UseHelp(CommandLineBuilder, String[])	Configura l'applicazione in modo da visualizzare la Guida quando viene usato uno degli alias di opzione specificati nella riga di comando.
UseHelp(CommandLineBuilder, Action<HelpContext>, Nullable<Int32>)	Configura l'applicazione in modo da visualizzare la Guida quando viene usato uno degli alias di opzione specificati nella riga di comando.

UseHelp(CommandLineBuilder, Nullable<Int32>)

Configura l'applicazione per visualizzare la Guida quando viene specificata una delle opzioni seguenti nella riga di comando:

-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

Parametri

builder

CommandLineBuilder

Generatore della riga di comando.

maxWidth

Nullable<Int32>

Larghezza massima dell'output per il generatore della Guida predefinito.

Restituisce

CommandLineBuilder

Stessa istanza di CommandLineBuilder.

UseHelp(CommandLineBuilder, String[])

Configura l'applicazione in modo da visualizzare la Guida quando viene usato uno degli alias di opzione specificati nella riga di comando.

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

Parametri

builder

CommandLineBuilder

Generatore della riga di comando.

helpAliases

String[]

Set di alias che possono essere specificati nella riga di comando per richiedere assistenza.

Restituisce

CommandLineBuilder

Stessa istanza di CommandLineBuilder.

Commenti

Gli alias specificati sostituiranno i valori predefiniti.

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

Configura l'applicazione in modo da visualizzare la Guida quando viene usato uno degli alias di opzione specificati nella riga di comando.

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

Parametri

builder

CommandLineBuilder

Generatore della riga di comando.

customize

Action<HelpContext>

Delegato che verrà chiamato per personalizzare la Guida se viene richiesta la Guida.

maxWidth

Nullable<Int32>

Larghezza massima dell'output per il generatore della Guida predefinito.

Restituisce

CommandLineBuilder

Stessa istanza di CommandLineBuilder.

Commenti

Gli alias specificati sostituiranno i valori predefiniti.