写文档时命令行中的括号如何使用?

338 阅读1分钟

前言

在编写或查看文档的时候,常常涉及到 命令行语法 示例的时候,会使用一些括号比如:尖括号、方括号、中括号、小括号等。下面我们逐个说一下

场景

git remote 为例:

image.png

尖括号<>

表示必填参数,需要使用相应的信息替换尖括号及里面的内容

示例:

git remote remove <名称>

方括号[]

表示可选参数,可以选择一个多个方括号内容,也可以不选

示例:

git remote get-url [--push] [--all] <名称>

小括号()

小括号表示在括号内的参数是互斥的,也就是说,在多个选项中只能选择一个进行操作,且必须选择。

git remote set-head <名称> (-a | --auto | -d | --delete | <分支>)

中括号属于可选参数,小括号属于必填参数; 小括号是选项式,尖括号是输入式

管道符|

它表示在一个方括号内的一个选项。如果两个参数由管道符号分隔开,您可以选择分隔符左边的元素,也可选择分隔符右边的元素。在一次命令使用中不可同时选择两个元素。在方括号中,这些选项是可选的。在尖括号中,至少需要一个选项

示例:

git remote [-v | --verbose] show [-n] <名称>

省略号……

表示前述元素(参数、值或信息)可以在命令行中多次重复

示例:

git remote set-branches [--add] <名称> <分支>...

总结

  • 尖括号:必填参数, 用户填写内容
  • 方括号:可选参数,取选项之一
  • 小括号:必选参数,取选项之一
  • 管道符:分割多个选项
  • 省略号:多次重复