参数表示方法及语法约定

表示方法

1. [ ]： 表示可选参数，使用时可以省略
2. < >： 表示必选参数，必须提供具体值
3. { }： 表示选择性参数，需从中选择一个选项，通常与 | 一起使用
4. ( )： 表示默认参数值
5. |： 表示互斥选项，只能选择其中一个
6. …： 表示可重复的前项，允许多次使用前面的参数
7. --： 通常表示长选项名称（如 --help）
8. -：通常表示短选项（如 -h）

特殊表示方法

• 粗体： 表示必须按原样键入的命令或关键字；
• 占位符：$VAR 或者 %VAR% 表示环境变量或者需要替换的值。

示例

命令行工具 (CLI)

# Linux/Unix man 页面风格
command [-a] [-b value] file...

# 多层嵌套表示
git checkout [-q] [-f] [-m] [<branch>]
git checkout [-q] [-f] [-m] --detach [<branch>]
git checkout [-q] [-f] [-m] [--detach] <commit>

# GNU 风格
program [OPTION]... [FILE]...

SQL 示例

case <col>
  when <v> then <answer>,
  [when <v> then <answer>,]
  [...]
  [else {answer}]
END [as alis];

Git 示例

git remote add [-t <branch>] [-m <master>] [-f] [--[no-]tags] [--mirror=<fetch|push>] <name> <url>