說明選項

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();
}

可以透過組態選項變更預設行為。

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

以程式設計方式或透過註解定義的命令將自動新增說明選項。使用註解模型，您只能全域關閉功能，程式化模型則提供修改每個命令設定的選項。