CommandLineBuilderExtensions.UseHelp Metoda

Definicja

Przestrzeń nazw:

System.CommandLine.Builder

Zestaw:

System.CommandLine.dll

Przeciążenia

UseHelp(CommandLineBuilder, Nullable<Int32>)	Konfiguruje aplikację, aby pokazać pomoc, gdy w wierszu polecenia określono jedną z następujących opcji: -h /h --help -? /?
UseHelp(CommandLineBuilder, String[])	Konfiguruje aplikację, aby pokazać pomoc, gdy jeden z określonych aliasów opcji jest używany w wierszu polecenia.
UseHelp(CommandLineBuilder, Action<HelpContext>, Nullable<Int32>)	Konfiguruje aplikację, aby pokazać pomoc, gdy jeden z określonych aliasów opcji jest używany w wierszu polecenia.

UseHelp(CommandLineBuilder, Nullable<Int32>)

Konfiguruje aplikację, aby pokazać pomoc, gdy w wierszu polecenia określono jedną z następujących opcji:

-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

Konstruktor wiersza polecenia.

maxWidth

Nullable<Int32>

Maksymalna szerokość danych wyjściowych dla domyślnego konstruktora pomocy.

Zwraca

CommandLineBuilder

To samo wystąpienie klasy CommandLineBuilder.

UseHelp(CommandLineBuilder, String[])

Konfiguruje aplikację, aby pokazać pomoc, gdy jeden z określonych aliasów opcji jest używany w wierszu polecenia.

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

Konstruktor wiersza polecenia.

helpAliases

String[]

Zestaw aliasów, które można określić w wierszu polecenia, aby poprosić o pomoc.

Zwraca

CommandLineBuilder

To samo wystąpienie klasy CommandLineBuilder.

Uwagi

Określone aliasy zastąpią wartości domyślne.

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

Konfiguruje aplikację, aby pokazać pomoc, gdy jeden z określonych aliasów opcji jest używany w wierszu polecenia.

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

Konstruktor wiersza polecenia.

customize

Action<HelpContext>

Pełnomocnik, który zostanie wywołany w celu dostosowania pomocy, jeśli zostanie poproszony o pomoc.

maxWidth

Nullable<Int32>

Maksymalna szerokość danych wyjściowych dla domyślnego konstruktora pomocy.

Zwraca

CommandLineBuilder

To samo wystąpienie klasy CommandLineBuilder.

Uwagi

Określone aliasy zastąpią wartości domyślne.