Partager via


CommandLineBuilderExtensions.UseHelp Méthode

Définition

Surcharges

UseHelp(CommandLineBuilder, Nullable<Int32>)

Configure l’application pour afficher de l’aide quand l’une des options suivantes est spécifiée sur la ligne de commande :

-h
/h
--help
-?
/?
UseHelp(CommandLineBuilder, String[])

Configure l’application pour afficher l’aide quand l’un des alias d’option spécifiés est utilisé sur la ligne de commande.

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

Configure l’application pour afficher l’aide quand l’un des alias d’option spécifiés est utilisé sur la ligne de commande.

UseHelp(CommandLineBuilder, Nullable<Int32>)

Configure l’application pour afficher de l’aide quand l’une des options suivantes est spécifiée sur la ligne de commande :

-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

Paramètres

builder
CommandLineBuilder

Générateur de ligne de commande.

maxWidth
Nullable<Int32>

Largeur de sortie maximale pour le générateur d’aide par défaut.

Retours

Le même instance de CommandLineBuilder.

S’applique à

UseHelp(CommandLineBuilder, String[])

Configure l’application pour afficher l’aide quand l’un des alias d’option spécifiés est utilisé sur la ligne de commande.

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

Paramètres

builder
CommandLineBuilder

Générateur de ligne de commande.

helpAliases
String[]

Ensemble d’alias qui peuvent être spécifiés sur la ligne de commande pour demander de l’aide.

Retours

Le même instance de CommandLineBuilder.

Remarques

Les alias spécifiés remplacent les valeurs par défaut.

S’applique à

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

Configure l’application pour afficher l’aide quand l’un des alias d’option spécifiés est utilisé sur la ligne de commande.

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

Paramètres

builder
CommandLineBuilder

Générateur de ligne de commande.

customize
Action<HelpContext>

Délégué qui sera appelé pour personnaliser l’aide si l’aide est demandée.

maxWidth
Nullable<Int32>

Largeur de sortie maximale pour le générateur d’aide par défaut.

Retours

Le même instance de CommandLineBuilder.

Remarques

Les alias spécifiés remplacent les valeurs par défaut.

S’applique à