命令行/shell 帮助文本是否有“标准”格式?

2024-04-29

如果没有,是否有事实上的标准?基本上我正在编写命令行帮助文本,如下所示:

usage: app_name [options] required_input required_input2
  options:
    -a, --argument     Does something
    -b required     Does something with "required"
    -c, --command required     Something else
    -d [optlistitem1 optlistitem 2 ... ]     Something with list

我基本上只是通过阅读各种工具的帮助文本来做到这一点,但是有指南列表之类的吗?例如,我使用方括号还是圆括号?如何使用间距?如果参数是一个列表怎么办?谢谢!


通常,您的帮助输出应包括:

  • 应用程序功能的描述
  • Usage syntax, which:
    • Uses [options]指示选项的去向
    • arg_name对于必需的单一参数
    • [arg_name]对于可选的单数参数
    • arg_name...对于可能有很多的必需参数(这种情况很少见)
    • [arg_name...]对于可以提供任意数字的 arg
    • 注意arg_name应该是一个描述性的短名称,采用小写蛇形写法
  • A nicely-formatted list of options, each:
    • 有一个简短的描述
    • 显示默认值(如果有)
    • 显示可能的值(如果适用)
    • 请注意,如果选项可以接受简短形式(例如-l)或长形式(例如--list),将它们包含在同一行,因为它们的描述是相同的
  • 可能是命令行参数来源的配置文件或环境变量位置的简要指示符,例如GREP_OPTS
  • 如果有手册页,请注明,否则,简要指示在哪里可以找到更详细的帮助

进一步注意,接受两者都是很好的形式-h and --help触发此消息and如果用户弄乱了命令行语法,例如,您应该显示此消息省略必需的参数。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

命令行/shell 帮助文本是否有“标准”格式? 的相关文章

随机推荐