[✔️]命令行选项的符号释义

481 阅读1分钟

开启掘金成长之旅!这是我参与「掘金日新计划 · 2 月更文挑战」的第 24 天,点击查看活动详情

日常开发经常会接触到非常多的命令,无论是哪门语言,哪个框架,都会有自己的cli,我们在使用cli的时候,如果我们不太熟悉怎么使用,通常我们都会如下这样获取帮助:

command -h
command --help

常见的选项符号

符号含义
[ ]表示是可选的,(写命令时要去掉括号)
< >表示是必须的,(写命令时要去掉括号)
x|y|z表示只能选择一个
-abc表示三个参数(或任何两个)的混合使用
表示该选项可以单个或多个
-单横线选项后面跟的参数必须是单字符参数,一个字符表示一个参数,可以多个参数写在同一个横线后面。
在选项需要加参数的时候,参数可以紧跟在选项后面,也可以使用空格分隔。
--双横线选项后面跟的参数必须是多字符参数(单词),双横线后只能跟一个参数。
在选项需要加参数的时候,参数可以使用“=”分隔,也可以使用空格分隔。

举例

我们看下CMAKE的帮助:

Usage
  cmake [options] <path-to-source>
  cmake [options] <path-to-existing-build>
  cmake [options] -S <path-to-source> -B <path-to-build>

可以看到这里有[]<>,那么这个意思就是options选项是可选的,但是<path-to-source>是必须的。

比如我们经常使用的cmake ..其实就是<path-to-source>参数

再拿CMAKE的一个api举例

project(<PROJECT-NAME> [<language-name>...])
project(<PROJECT-NAME>
        [VERSION <major>[.<minor>[.<patch>[.<tweak>]]]]
        [DESCRIPTION <project-description-string>]
        [HOMEPAGE_URL <url-string>]
        [LANGUAGES <language-name>...])

参数的不同,对应的help也不同,这里面你会看到[]<>嵌套的情况,这个也很好理解了,只要看准对应的配对符号位置,基本意思仍旧没有发生变化的。

掌握的以上最基本的规则,基本上都能看懂大部分的help。

windows cmd命令行选项

cmd /?