HelpOption Класс

Определение

Пространство имен:

System.CommandLine.Help

Сборка:

System.CommandLine.dll

Пакет:

System.CommandLine v3.0.0-preview.1.26104.118

Исходный код:

HelpOption.cs

Стандартный параметр, указывающий на то, что должна отображаться справка командной строки.

public ref class HelpOption sealed : System::CommandLine::Option

public sealed class HelpOption : System.CommandLine.Option

type HelpOption = class
    inherit Option

Public NotInheritable Class HelpOption
Inherits Option

Наследование

Object

Symbol

Option

HelpOption

Конструкторы

Имя	Описание
HelpOption()	При добавлении Commandв приложение настраивается отображение справки при указании одного из следующих параметров в командной строке: -h /h --help -? /?
HelpOption(String, String[])	При добавлении Commandв приложение настраивается отображение справки при указании имени или одного из псевдонимов в командной строке.

Свойства

Имя	Описание
Action	Возвращает или задает CommandLineAction параметр. Обработчик представляет действие, которое будет выполняться при вызове параметра.
Aliases	Получает уникальный набор строк, которые можно использовать в командной строке для указания параметра. (Унаследовано от Option)
AllowMultipleArgumentsPerToken	Возвращает значение, указывающее, разрешено ли для каждого маркера идентификатора параметра несколько маркеров аргумента. (Унаследовано от Option)
Arity	Возвращает или задает arity параметра. (Унаследовано от Option)
CompletionSources	Возвращает список источников завершения для параметра. (Унаследовано от Option)
Description	Возвращает или задает описание символа. (Унаследовано от Symbol)
HasDefaultValue	Указывает, определено ли значение по умолчанию для параметра. (Унаследовано от Option)
HelpName	Возвращает или задает имя заполнителя, отображаемое в справке по использованию для значения параметра. Значение будет упаковано в угловые скобки (< и >). (Унаследовано от Option)
Hidden	Возвращает или задает значение, указывающее, скрыт ли символ. (Унаследовано от Symbol)
Name	Возвращает имя символа. (Унаследовано от Symbol)
Parents	Возвращает родительские символы. (Унаследовано от Symbol)
Recursive	Если задано значение true, этот параметр будет применяться к его немедленной родительской команде или командам и рекурсивно к их подкомандам. (Унаследовано от Option)
Required	Указывает, является ли параметр обязательным при вызове родительской команды. (Унаследовано от Option)
Validators	Проверяющие элементы, которые будут вызываться при сопоставлении параметра синтаксического анализа. (Унаследовано от Option)
ValueType	Стандартный параметр, указывающий на то, что должна отображаться справка командной строки.

Методы

Имя	Описание
GetCompletions(CompletionContext)	Возвращает завершения для символа. (Унаследовано от Option)
GetDefaultValue()	Возвращает значение по умолчанию для параметра. (Унаследовано от Option)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Symbol)