ラベル

Option Label は、デフォルトの help コマンドが出力するもの以外に、シェル自体の中で関数振る舞いをしません。コマンドドキュメント内で、オプションの型がドキュメント化されていますが、これは常に非常に役立つとは限りません。オプションをよりよく説明する言葉を付けたいと思うかもしれません。

ラベルは legacy annotation ではサポートされていません。
  • プログラマティック

  • アノテーション

CommandRegistration labelOption() {
	return CommandRegistration.builder()
		.withOption()
			.longNames("arg")
			.label("MYLABEL")
			.and()
		.build();
}
void labelOption(
	@Option(label = "MYLABEL") String arg
) {
}

ラベルの定義は help に表示されます。

my-shell:>help labelOption
NAME
       labelOption -

SYNOPSIS
       labelOption --arg MYLABEL

OPTIONS
       --arg MYLABEL
       [Optional]