1 引子

前几天，后台突然多了几个咨询命令行参数规范的问题。总结起来大致有如下几个：

1）命令行参数，为什么有的用- 有的用--，这些有什么区别；

2）如何能够更快的记住命令行参数，例如 git pull -t -f 之类的，过段时间就忘记了；

3）别看用了这么多次命令，都是网上复制，命令行的设计有没有什么明确的规范。

...

基于以上的问题，我打算给大家讲讲我自己的理解。

2 从一个小案例开始

我在讲解一个概念的时候，并不是直接告诉结果，而是从一个实际的案例，带着大家逐步去了解认识这个新的知识点，对于命令行参数，也是一样。

要想理解一个概念的定义，一般我们可以先思考，如果自己设计，应该是怎样的。

接下来我们就以大家熟悉的copy命令来举例。

产品经理小明让我做个名叫file的文件操作工具，该工具可以支持文件的拷贝和移动，且只提供命令行操作，那么我们应该如何设计呢。

可以使用如下表格的方法来设计

1）应用程序，file.exe；

2）命令，copy复制和move移动；

3）参数，src-源文件路径 dest-目标文件路径；

4）工具代码，main.cpp中，编写两个函数，分别处理copy和move命令。

好，从上图中，我们发现了一个规律：

命令行的每个命令都与一个函数一一对应 那么我们是否可以得出这样一个结论： 命令行的本质，就是将一个字符串列表翻译成与之对应函数调用。也可以理解成，通过字符串调用函数。

例如：file copy a.txt b.txt 将调用 doCopy函数

2.1 位置参数

既然命令行的目标是函数，那么我们的设计就依照函数的规范来。

从上图，我们可以看出：

1）copy命令对应doCopy函数名称；

2）a.txt和b.txt这两个文件名，对应doCopy函数的参数，且参数顺序要一一对应。

由此，我们总结出命令行规范的第一个术语：

位置参数

参数的顺序不可互换

现在提出一个问题，如果我们不提供b.txt，会怎么样呢？

有两种结果：

1）程序报错；

2）使用默认值。

这不就联想到了函数的默认参数了吗，所以命令行规范，遵循函数声明规范

就像这样，我们可以输入 file copy a.txt，该命令会将a.txt 拷贝到undefined.txt：

bool doCopy(const string& src, const string& dest="./undefined.txt")

2.2 选项参数

上一小节我们知道了位置参数，也了解了默认参数。

那么，如果想让src有默认参数，dest为指定的位置参数，这时应该怎么办呢?

// 显然命令行输入 "file copy b.txt" 是无法将参数b.txt赋值给dest，使用位置参数，程序只能识别出b.txt是赋值给src形参的
bool doCopy(const string& src="./a.txt", const string& dest);  // error 这样的声明是错误的

我们无法将b.txt传给dest形参，那么有没有其它的办法呢。答案当然是有的，因为我们不要忘记，命令行的本质就是把字符串列表转化为对应的函数调用，我们可以在转换的过程中做文章。

因为我们是通过位置来和参数做对应的，现在位置无法满足我们的需求，那我们可以直接通过关键字来指定参数，例如：

file copy --src=a.txt

通过"--参数名称"的方式，我们直接使用关键字来指定参数，这样就知道doCopy的实参要赋给哪个形参了。

我们经常使用命令行，有些“懒人”觉得输入=太麻烦了，不如用“空格”方便，所以就有了下面的变种

file copy --src a.txt // 将=替换成空格，输入更方便
file copy src=a.txt // 去掉--，通过=区分形参，是不是特别像python里面的字典参数赋值呢
file copy -src a.txt // 使用-也可以，但一般不这样用，这会产生歧义，后面会讲到

大家想想，为什么参数名称前面加--呢，那是因为如果不加，src是表示参数名称还是实参就产生了歧义，所以我们约定：凡是参数名，那么前面就加--，同时我们不允许输入的实参里面包含=号。

2.3 布尔参数

我们在使用命令行参数时，为了不修改代码，经常会使用一些开关（bool）参数。

例如 file copy -f a.txt b.txt 其中-f表示强制覆盖文件

再如gcc -w 表示关掉警告信息，-g表示生成调试信息。

于是，这些懒人又对命令行进行了新的规定

使用"-字符"表示bool值，注意这里是一个字符。

例如 file copy -f

1）当有 -f 时，表示true，强制覆盖。

2）没有 -f 时，表示false，不进行覆盖。

当我们有多个bool选项时，例如

file copy -f -q a.txt b.txt 这表示强制覆盖，-q表示即使错误也没关系，不展示错误信息。

于是懒人又想了，既然这么多开关，我要连续输入很多的杠和空格，非常麻烦，于是有了下面的合并写法

file copy -fq a.txt b.txt

嗯，这回不错，书写方便多了，但这会与上面讲到的"file copy -src a.txt"产生歧义，-src是代表src还是-s -r -c呢？

所以，我们在设计命令行时，可以强制规定

1）单个-单个字符 就表示一个开关；

2）单个-多个字符 就表示多个开关合并；

3）两个-- 就表示完整的参数名。

大家发现没有，开关参数，实际上就是特殊的，精简版的选项参数。例如-f 可以写成 --force=true/false

3 总结

最后，我用三张图再来总结下整个命令行语法

好了，以上就是命令行的全部语法了。

可能有些人都只是使用命令行，但没有思考过他的语法，这次我们做了这样比较全面的总结，记忆起来更方便了，同时按照上面的内容来设计工具，基本上就符合大部分人的使用习惯了。

关于命令行，比较重要的就是解析器的开发了，那么下一篇文章就给大家介绍下Qt处理命令行的方法了。

以下是我做的Qt客户端开发实战，其中的项目部分，详细介绍了我的客户端的架构设计理念，有兴趣的同学可以参考了解一下。

Qt 全流程实战企业级项目 - 云对象存储浏览器_实战课程_慕课网