Команда для отображения справочной информации о других командах. Подробнее...

#include <HelpCommand.hxx>

Граф наследования:svcs::cli::HelpCommand:

Открытые члены
	HelpCommand (std::shared_ptr< ISubject > subject, std::shared_ptr< HelpService > helpService)
	Конструирует HelpCommand.
bool	execute (const std::vector< std::string > &args) override
	Выполняет логику команды help.
std::string	getName () const override
	Получает имя команды.
std::string	getDescription () const override
	Получает краткое описание команды.
std::string	getUsage () const override
	Получает синтаксис использования команды.
void	showHelp () const override
	Показывает подробную справочную информацию для этой конкретной команды через шину событий.
Открытые члены унаследованные от svcs::cli::ICommand
virtual	~ICommand ()=default
	Виртуальный деструктор.

Подробное описание

Команда для отображения справочной информации о других командах.

HelpCommand является встроенной утилитой справки приложения. Она может показывать общий список всех доступных команд или отображать подробное использование и описания для конкретной команды, предоставленной в качестве аргумента. Она делегирует получение информации о командах в HelpService для поддержания чистого разделения ответственности.

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

◆ HelpCommand()

svcs::cli::HelpCommand::HelpCommand	(	std::shared_ptr< ISubject >	subject,
		std::shared_ptr< HelpService >	helpService )

Конструирует HelpCommand.

Аргументы

subject	Общий указатель на шину событий для логирования и выходных уведомлений.
helpService	Общий указатель на зависимость сервиса справки.

Методы

◆ execute()

bool svcs::cli::HelpCommand::execute ( const std::vector< std::string > & args )

overridevirtual

Выполняет логику команды help.

Аргументы

args	Аргументы команды. Если вектор пуст, показывается общая справка. Если он содержит одно имя команды, показывается подробная справка для этой команды.