help message的约定俗成

help message的约定俗成

经常使用man手册或者--help参数来显示某个程序(命令)的帮助信息时总会看到类似于下面的内容输出:

不同的命令显示帮助信息的形式都是类似的, 其中最常见的就是括号(brackets)的使用.

虽然帮助信息的自定义属性很强烈, 但是在括号的使用上作者们似乎还是形成了一个约定俗成的规矩:

reference link

方括号: [代表可选参数]

尖括号:<代表必要参数>

大括号:{代表默认值}

小括号:(可以是除上述之外的一些其他信息)

这些规矩不仅仅在shell命令上适用, 在看编程语言API时也同样可以参考一下~