是否有编写 --help 消息的约定？

【问题标题】：Are there conventions to writing a --help message?是否有编写 --help 消息的约定？
【发布时间】：2014-11-21 20:42:51
【问题描述】：

我正在编写我的第一个真正的 shell 脚本，我想输入正确的 --help 消息。查看各种命令行程序，我至少看到了某种模式：

$ command --help
Usage: command [OPTION] [FILE]
Performs some action to a file.

-x  changes the command in some way
-y  changes the command in a different way

这是写在任何地方还是只是一个非正式的约定？

【问题讨论】：

标签： bash shell command-line-interface

【解决方案1】：

与 UNIX 中的许多（大多数）东西一样，这纯粹是一种传统。程序员发现这些--help 消息很有用，因此他们尝试模仿他们认为最有用的--help 消息，传统由此诞生。对于第一次接触 UNIX 的人来说有点不幸的是，这些传统通常需要一些时间才能以某种方式被编纂，根本没有关于这类东西的全面来源。

因此，只需将您认为对您知道的 --help 消息有用的所有内容进行无耻复制，然后添加您认为有用的内容。尽可能地做同样的事情，你将尽可能地忠于 UNIX 传统......

【讨论】：