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

内容来源于 Stack Overflow,并遵循CC BY-SA 3.0许可协议进行翻译与使用

  • 回答 (2)
  • 关注 (0)
  • 查看 (14)

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

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

提问于
用户回答回答于

通常,帮助输出应该包括:

  • 应用程序的功能描述
  • 用法语法,其中:
    • 用于[options]指示选项的位置
    • arg_name 为一个必需的,单数的arg
    • [arg_name] 为一个可选的单数arg
    • arg_name… 对于需要的参数可以有很多(这很少见)
    • [arg_name…] 对于可以提供任何数字的arg
    • 注意,arg_name应该是一个描述性的短名称,在较低的蛇形情况下

用户回答回答于

看看docopt。它是记录(和自动分析)命令行参数的正式标准。

例如...

Usage:
  my_program command --option <argument>
  my_program [<optional-argument>]
  my_program --another-option=<with-argument>
  my_program (--either-that-option | <or-this-argument>)
  my_program <repeating-argument> <repeating-argument>...

扫码关注云+社区