CommandLineBuilderExtensions.UseHelp Método

Definición

Espacio de nombres:

System.CommandLine.Builder

Ensamblado:

System.CommandLine.dll

Sobrecargas

UseHelp(CommandLineBuilder, Nullable<Int32>)	Configura la aplicación para mostrar ayuda cuando se especifica una de las siguientes opciones en la línea de comandos: -h /h --help -? /?
UseHelp(CommandLineBuilder, String[])	Configura la aplicación para mostrar ayuda cuando se usa uno de los alias de opción especificados en la línea de comandos.
UseHelp(CommandLineBuilder, Action<HelpContext>, Nullable<Int32>)	Configura la aplicación para mostrar ayuda cuando se usa uno de los alias de opción especificados en la línea de comandos.

UseHelp(CommandLineBuilder, Nullable<Int32>)

Configura la aplicación para mostrar ayuda cuando se especifica una de las siguientes opciones en la línea de comandos:

-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

Parámetros

builder

CommandLineBuilder

Generador de líneas de comandos.

maxWidth

Nullable<Int32>

Ancho máximo de salida para el generador de ayuda predeterminado.

Devoluciones

CommandLineBuilder

La misma instancia de CommandLineBuilder.

UseHelp(CommandLineBuilder, String[])

Configura la aplicación para mostrar ayuda cuando se usa uno de los alias de opción especificados en la línea de comandos.

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

Parámetros

builder

CommandLineBuilder

Generador de líneas de comandos.

helpAliases

String[]

Conjunto de alias que se pueden especificar en la línea de comandos para solicitar ayuda.

Devoluciones

CommandLineBuilder

La misma instancia de CommandLineBuilder.

Comentarios

Los alias especificados invalidarán los valores predeterminados.

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

Configura la aplicación para mostrar ayuda cuando se usa uno de los alias de opción especificados en la línea de comandos.

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

Parámetros

builder

CommandLineBuilder

Generador de líneas de comandos.

customize

Action<HelpContext>

Delegado al que se llamará para personalizar la ayuda si se solicita ayuda.

maxWidth

Nullable<Int32>

Ancho máximo de salida para el generador de ayuda predeterminado.

Devoluciones

CommandLineBuilder

La misma instancia de CommandLineBuilder.

Comentarios

Los alias especificados invalidarán los valores predeterminados.