Label

Option Label 本身在 shell 中没有功能行为，只是输出默认 help 命令。在命令文档中会记录选项类型，但这并不总是特别有用。因此您可能想为选项提供更好的描述性单词。

legacy annotation 不支持标签。

  • Programmatic

  • Annotation

link:../../../../src/test/java/org/springframework/shell/docs/OptionSnippets.java[role=include]
link:../../../../src/test/java/org/springframework/shell/docs/OptionSnippets.java[role=include]

然后在 help 中显示定义的标签。

my-shell:>help labelOption
NAME
       labelOption -

SYNOPSIS
       labelOption --arg MYLABEL

OPTIONS
       --arg MYLABEL
       [Optional]