一、前言
在技术文档中，命令行（CLI）相关内容的符号使用是否统一、规范，直接决定了用户的阅读效率与操作准确性。混乱的符号标注容易让初学者产生误解，甚至在实际操作中引发参数错误、权限异常等问题。本文将整理并梳理命令行文档符号的规范。
二、主要符号规范
1. 尖括号 <>：必填占位参数
用于表示必须由用户自定义输入的参数，无默认值，缺失则命令执行失败。括号仅为文档标识，输入命令时不携带尖括号。
示例：
ping <IP地址>2. 方括号 []：可选参数/选项
用于表示可省略的参数、选项或后缀，省略时命令使用默认逻辑，输入命令时不携带方括号。
正确示例：
npm install [--save-dev]3. 大括号 {}：固定取值集合
用于定义固定枚举值，用户只能从集合内选择，不可自定义输入，常用于模式、环境、状态参数。
示例：
npm run {dev|build}4. 竖线 |：互斥多选一
用于分隔相互排斥的可选值，同一位置只能选择一个，不可多选、不混用。可搭配尖括号/花括号使用。
docker logs <容器ID|容器名称>5. 省略号 ...：多参数复用
表示前方参数可重复传入多个，支持批量传参，常用于文件、路径、名称等场景。
示例：
rm <文件名称>...6. 短横线/双横线 - / --：命令选项
短选项（-）：单字母简写，紧凑简洁，多可合并使用。示例：
ls -lh长选项（--）：完整单词，语义清晰，不可合并。示例：
ls --human-readable
三、其他使用规范
复杂参数可嵌套组合
可选+必填：
command [--type <类型>]可选+多枚举：
command [mode={fast|full|min}]必填+多参数：
copy <源文件...> <目标路径>
交互式提示场景
标记终端输出的提示符时，需用固定符号区分不同权限的用户，避免用户混淆操作身份：
root 用户提示符：用
#开头，代表当前操作需要管理员权限普通用户提示符：用
$开头，代表当前操作无需 root 权限
示例：
# root用户操作
root@localhost:~# systemctl restart nginx
# 普通用户操作
user@localhost:~$ cd ~/projects四、附录
标准命令模板：
命令名 [可选选项] <必填参数> [<可多传参数>...] [--配置={值1|值2}]
命令行文档符号定义：
评论