命令行帮助文档的格式

在命令行中，查看一个命令的帮助，会得到一些格式非常清晰的文档。因为这种文档格式非常清晰，一般情况下，大家都能大概理解文档的意思。但是只有了解了文档的格式，才能真正读懂文档包含的所有信息。

如下面的截图所示，这个是通过git --help获取的帮助文档。文档中的[xxx],--xxx,<xxx>等具体表示什么意思呢？哪些是必须要填的参数哪些是可选的呢？要了解这些，我们需要学习一种格式语言。这种语言叫做的’命令行接口描述语言‘，英文名字叫做’command-line interface description language‘。大多数的命令行的帮助文档都是遵循该语言的规范撰写的。

本文重要介绍该语言中四个常用的格式。

1、位置参数（ARGMENT）

     <xxx>中xxx表示的是位置参数。位置参数

2、选项（OPTION）

    -x表示短选项，--xx表示长选项。多个短选项可以合并，例如-abc相当于-a -b -c。短选项后面可以跟参数（假设短选项名为x，长选项名为xx，参数是FIle），格式为-x File活着-xFile。长选项后面也可以跟参数，格式是为--xx=File活着--xx File。

3、子命令

    所有没有跟OPTION和ARGMENT的单词都认为是该命令的子命令。

4、可选元素

    通过用一对中括号包起来的都是可选的。例如下图中[--version]就是一个可选的。

（更多有关命令行接口描述语言的内容可以参见此处：http://docopt.org）