如果没有，是否有一种事实上的标准？基本上我正在编写命令行帮助文本，如下所示：
usage: app_name [options] required_input required_input2
options:
-a, --argument Does something
-b required Does something with "required"
-c, --command required Something else
-d [optlistitem1 optlistitem 2 ... ] Something with list
我基本上只是阅读各种工具的帮助文本制作的，但是否有指南或类似的东西呢？例如，我使用方括号还是圆括号？如何使用间距？如果参数是列表怎么办？谢谢！
通常，您的帮助文档应包括：
[options]来指示选项的位置arg_name表示必需的单个参数[arg_name]表示可选的单个参数arg_name...表示必需的多个参数（这种情况很少见）[arg_name...]表示可以提供任意数量的参数arg_name应该是一个描述性的、简短的名称，采用小写下划线格式-l）或长形式（例如--list），请将它们一起放在同一行上，因为它们的描述是相同的GREP_OPTS另外需要注意的是，为了触发此消息，良好的做法是接受-h和--help两种方式，并且如果用户在命令行语法上出现错误（例如省略必需的参数），应显示此消息。
usage: move (+|-)pixels，也就是要求 + 或 - 其中之一是 必需 的？（我知道我可以有两个使用行，但我喜欢每个新参数时将它们加倍。）你能想到一个标准工具的例子吗？ - Alois Mahdal{a|b|c|...}这样的表达，它要求一个单一的参数，该参数必须是a、b、c等之一。例如，在我的系统中没有参数运行service sddm会打印出Usage: /etc/init.d/sddm {start|stop|status|restart|try-restart|force-reload}。因此，大多数人可能会理解usage: move {+|-}pixels}，特别是如果给出一个例子：example: move +5。 - Braden Best看一下docopt。它是一个正式的标准，用于记录（并自动解析）命令行参数。
例如...
Usage:
my_program command --option <argument>
my_program [<optional-argument>]
my_program --another-option=<with-argument>
my_program (--either-that-option | <or-this-argument>)
my_program <repeating-argument> <repeating-argument>...
-o。-o argument 或 -oargument。-lst 等同于 -t -l -s。-lst 等同于 -tls。-lst nonoption。-- 参数终止选项。- 选项通常用于表示标准输入流之一。微软有自己的命令行标准规范:
该文档主要针对命令行工具的开发人员。我们的共同目标是提供一致可组合的命令行用户体验。通过实现这样的目标，用户可以学习一组核心概念（语法、命名、行为等），并能够将这些知识应用到大量命令的工作中。这些命令应该能够以标准化的格式输出标准化的数据流，以便进行轻松的组合而无需解析输出文本的流。该文档的编写独立于任何特定的 shell 实现、一组实用程序或命令创建技术；但附录 J - 使用 Windows PowerShell 实现 Microsoft 命令行标准展示了如何使用 Windows PowerShell 免费实现这些指南的许多功能。
GNU编码规范是这方面的一个好参考。 这个章节 讨论了--help的输出。 在这种情况下，它不是非常具体。 打印显示短选项和长选项以及简明描述的表格可能是正确的选择。 尝试为可读性正确设置所有参数之间的间距。 可能需要提供一个man页（可能还有一个info手册），以提供更详细的说明。
虽然有点偏题，但我曾经编写了两个小工具，可以更有效地创建和维护命令行工具的帮助页面：
我将这两个工具集成到我的程序的MAVEN构建过程中，以便它们在每次构建时自动执行。
例如：
希望对其他人有所帮助！？
是的，你走在正确的道路上。
是的，方括号通常用于表示可选项。
通常情况下，就像你所描述的那样，在顶部有一个命令行摘要，然后是详细信息，最好为每个选项提供示例。（你的示例显示了每个选项描述之间的行，但我假设这是编辑问题，并且你的真实程序输出缩进的选项列表，没有空行。无论如何，这都是要遵循的标准。）
一种较新的趋势（也许有一个POSIX规范来解决这个问题？）是消除man页面系统的文档，并将所有可能出现在man页面中的信息包含在program --help输出中。这个额外的内容将包括更长的描述，概念解释，使用示例，已知的限制和错误，如何报告错误，以及可能的“参见”部分，用于相关命令。
希望这可以帮到你。
someCommand --help 时，我只需要一个小提示来提醒我参数的精确顺序，而不是一大堆填满屏幕的文本，需要将其管道传输到 less 中才能查看全部内容。手册应该是放置长详细描述的地方，而不是帮助文本。 - AJMansfield如果您需要例子，请参见 MDN 上的 正式定义 部分；这是一个关于Component values may be arranged into property values as follows:
- Several juxtaposed words mean that all of them must occur, in the given order.
- A bar (
|) separates two or more alternatives: exactly one of them must occur.- A double bar (
||) separates two or more options: one or more of them must occur, in any order.- A double ampersand (
&&) separates two or more components, all of which must occur, in any order.- Brackets (
[ ]) are for grouping.Juxtaposition is stronger than the double ampersand, the double ampersand is stronger than the double bar, and the double bar is stronger than the bar. Thus, the following lines are equivalent:
a b | c || d && e f [ a b ] | [ c || [ d && [ e f ]]]Every type, keyword, or bracketed group may be followed by one of the following modifiers:
- An asterisk (
*) indicates that the preceding type, word, or group occurs zero or more times.- A plus (
+) indicates that the preceding type, word, or group occurs one or more times.- A question mark (
?) indicates that the preceding type, word, or group is optional.- A pair of numbers in curly braces (
{A,B}) indicates that the preceding type, word, or group occurs at least A and at most B times.
font 的例子：https://developer.mozilla.org/en-US/docs/Web/CSS/font#formal_syntax。$ pandoc <input_file>.md --from [markdown|commonmark_x][-smart]? --to html --standalone --table-of-contents? --number-sections? [--css <style_sheet>.css]? --output <output_file>.html
--help输出应该如何看的链接。但两个问题都是合并的好候选。 - pmr