帮助选项

ChatGPT-4o-mini 中英对照 Help Options

Spring Shell 有一个内置的 help 命令，但并不是所有人都喜欢从中获取命令帮助，因为你总是需要带上目标命令的参数来调用它。在许多 CLI 框架中，每个命令都有选项 --help 和 -h 来打印命令帮助，这是很常见的。

默认功能是每个命令都会被修改为具有选项 --help 和 -h，如果在给定命令中存在这些选项，将自动跳过命令执行，转而执行现有的 help 命令，无论输入了什么其他命令行选项。

以下示例显示其默认设置。

@Bean
CommandRegistration commandRegistration() {
	return CommandRegistration.builder()
		.command("mycommand")
		.withHelpOptions()
			.enabled(true)
			.longNames("help")
			.shortNames('h')
			.command("help")
			.and()
		.build();
}

java

可以通过配置选项改变默认行为。

spring:
  shell:
    help:
      enabled: true
      long-names: help
      short-names: h
      command: help

yaml

备注

通过编程或注释定义的命令将自动添加帮助选项。使用注释模型，您只能全局关闭某些功能，而编程模型则提供了按命令修改设置的选项。