CommandLineBuilderExtensions.UseHelp Methode

Definition

Namespace:

System.CommandLine.Builder

Assembly:

System.CommandLine.dll

Überlädt

UseHelp(CommandLineBuilder, Nullable<Int32>)	Konfiguriert die Anwendung so, dass hilfe angezeigt wird, wenn eine der folgenden Optionen in der Befehlszeile angegeben ist: -h /h --help -? /?
UseHelp(CommandLineBuilder, String[])	Konfiguriert die Anwendung so, dass Hilfe angezeigt wird, wenn einer der angegebenen Optionsalias in der Befehlszeile verwendet wird.
UseHelp(CommandLineBuilder, Action<HelpContext>, Nullable<Int32>)	Konfiguriert die Anwendung so, dass Hilfe angezeigt wird, wenn einer der angegebenen Optionsalias in der Befehlszeile verwendet wird.

UseHelp(CommandLineBuilder, Nullable<Int32>)

Konfiguriert die Anwendung so, dass hilfe angezeigt wird, wenn eine der folgenden Optionen in der Befehlszeile angegeben ist:

-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

Parameter

builder

CommandLineBuilder

Ein Befehlszeilen-Generator.

maxWidth

Nullable<Int32>

Maximale Ausgabebreite für den Standardmäßigen Hilfe-Generator.

Gibt zurück

CommandLineBuilder

Die gleiche instance von CommandLineBuilder.

UseHelp(CommandLineBuilder, String[])

Konfiguriert die Anwendung so, dass Hilfe angezeigt wird, wenn einer der angegebenen Optionsalias in der Befehlszeile verwendet wird.

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

Parameter

builder

CommandLineBuilder

Ein Befehlszeilen-Generator.

helpAliases

String[]

Der Satz von Aliasen, die in der Befehlszeile angegeben werden können, um Hilfe anzufordern.

Gibt zurück

CommandLineBuilder

Die gleiche instance von CommandLineBuilder.

Hinweise

Die angegebenen Aliase überschreiben die Standardwerte.

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

Konfiguriert die Anwendung so, dass Hilfe angezeigt wird, wenn einer der angegebenen Optionsalias in der Befehlszeile verwendet wird.

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

Parameter

builder

CommandLineBuilder

Ein Befehlszeilen-Generator.

customize

Action<HelpContext>

Ein Delegat, der aufgerufen wird, um hilfe anzupassen, wenn Hilfe angefordert wird.

maxWidth

Nullable<Int32>

Maximale Ausgabebreite für den Standardmäßigen Hilfe-Generator.

Gibt zurück

CommandLineBuilder

Die gleiche instance von CommandLineBuilder.

Hinweise

Die angegebenen Aliase überschreiben die Standardwerte.