Class DefaultHelpOptionConvention
Adds a help option of --help if no other help option is specified.
Inheritance
System.Object
DefaultHelpOptionConvention
Implements
Namespace: McMaster.Extensions.CommandLineUtils.Conventions
Assembly: McMaster.Extensions.CommandLineUtils.dll
Syntax
public class DefaultHelpOptionConvention : IConventionConstructors
| Improve this Doc View SourceDefaultHelpOptionConvention(String)
Initializes an instance of DefaultHelpOptionConvention.
Declaration
public DefaultHelpOptionConvention(string template)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | template |
Fields
| Improve this Doc View SourceDefaultHelpTemplate
The default help template.
Declaration
public const string DefaultHelpTemplate = "-?|-h|--help"Field Value
| Type | Description |
|---|---|
| System.String |
Methods
| Improve this Doc View SourceApply(ConventionContext)
Apply the convention.
Declaration
public void Apply(ConventionContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ConventionContext | context | The context in which the convention is applied. |