在我的自定义 shell 脚本的使用字符串中,我是否还应该显示 --help 和 --version?

在我的自定义 shell 脚本的使用字符串中,我是否还应该显示 --help 和 --version?

我目前正在开发一个名为 的 shell 脚本up,当使用 调用时,它会在命令行上显示用法字符串--help。输出如下所示:

$ up --help
usage: up [-n levels][--help][--versions][basename]...

这看起来不错,但我想知道我是否真的需要显示--help--version选项,因为它们是广泛接受的标准,并且似乎只会给使用字符串添加噪音。

答案1

这完全取决于你,但大多数程序都会这样做

program --help

Usage: program [<options>][<arguments> ...]

Options:
--help         show this message, then exit
--something    after some spaces for alignment, an explenation follows.

你应该检查一下获取选择大多数程序(这也可以在编程语言中使用)和脚本使用。这样使用您的脚本的人就不会感到困惑。

最后,你应该添加全部你的选择,即使它们对你来说似乎微不足道。因此,我会在用法的选项部分添加 --help 和 --version 。

相关内容