CommandLineBuilderExtensions.UseHelp Método

Definição

Namespace:

System.CommandLine.Builder

Assembly:

System.CommandLine.dll

Sobrecargas

UseHelp(CommandLineBuilder, Nullable<Int32>)	Configura o aplicativo para mostrar ajuda quando uma das seguintes opções é especificada na linha de comando: -h /h --help -? /?
UseHelp(CommandLineBuilder, String[])	Configura o aplicativo para mostrar ajuda quando um dos aliases de opção especificados é usado na linha de comando.
UseHelp(CommandLineBuilder, Action<HelpContext>, Nullable<Int32>)	Configura o aplicativo para mostrar ajuda quando um dos aliases de opção especificados é usado na linha de comando.

UseHelp(CommandLineBuilder, Nullable<Int32>)

Configura o aplicativo para mostrar ajuda quando uma das seguintes opções é especificada na linha de 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

Parâmetros

builder

CommandLineBuilder

Um construtor de linha de comando.

maxWidth

Nullable<Int32>

Largura máxima de saída para o construtor de ajuda padrão.

Retornos

CommandLineBuilder

A mesma instância de CommandLineBuilder.

UseHelp(CommandLineBuilder, String[])

Configura o aplicativo para mostrar ajuda quando um dos aliases de opção especificados é usado na linha de 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

Parâmetros

builder

CommandLineBuilder

Um construtor de linha de comando.

helpAliases

String[]

O conjunto de aliases que podem ser especificados na linha de comando para solicitar ajuda.

Retornos

CommandLineBuilder

A mesma instância de CommandLineBuilder.

Comentários

Os aliases especificados substituirão os valores padrão.

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

Configura o aplicativo para mostrar ajuda quando um dos aliases de opção especificados é usado na linha de 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

Parâmetros

builder

CommandLineBuilder

Um construtor de linha de comando.

customize

Action<HelpContext>

Um delegado que será chamado para personalizar a ajuda se a ajuda for solicitada.

maxWidth

Nullable<Int32>

Largura máxima de saída para o construtor de ajuda padrão.

Retornos

CommandLineBuilder

A mesma instância de CommandLineBuilder.

Comentários

Os aliases especificados substituirão os valores padrão.