如果没有，是否存在一个事实上的标准?基本上，我正在编写命令行帮助文本，如下所示:
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
我基本上只是阅读了各种工具的帮助文本，但是否有指南列表或其他内容?例如，我是用方括号还是圆括号?如何使用空格?如果参数是一个列表呢?谢谢!
当前回答
微软有自己的命令行标准规范:
This document is focused at developers of command line utilities. Collectively, our goal is to present a consistent, composable command line user experience. Achieving that allows a user to learn a core set of concepts (syntax, naming, behaviors, etc) and then be able to translate that knowledge into working with a large set of commands. Those commands should be able to output standardized streams of data in a standardized format to allow easy composition without the burden of parsing streams of output text. This document is written to be independent of any specific implementation of a shell, set of utilities or command creation technologies; however, Appendix J - Using Windows Powershell to implement the Microsoft Command Line Standard shows how using Windows PowerShell will provide implementation of many of these guidelines for free.
其他回答
看一下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>...
我们运行的是Linux，一个基本符合posix的操作系统。它应该是POSIX标准:实用程序参数语法。
An option is a hyphen followed by a single alphanumeric character, like this: -o. An option may require an argument (which must appear immediately after the option); for example, -o argument or -oargument. Options that do not require arguments can be grouped after a hyphen, so, for example, -lst is equivalent to -t -l -s. Options can appear in any order; thus -lst is equivalent to -tls. Options can appear multiple times. Options precede other nonoption arguments: -lst nonoption. The -- argument terminates options. The - option is typically used to represent one of the standard input streams.
我会以官方项目为例，比如tar。在我看来，帮助味精。需要尽可能的简单和描述性。使用的例子也很好。对“标准帮助”没有真正的需求。
是的，你的思路是对的。
是的，方括号是可选项目的常用指示符。
通常，正如您所勾勒的那样，在顶部有一个命令行摘要，后面是详细信息，理想情况下每个选项都有示例。(您的示例显示了每个选项描述之间的行，但我假设这是一个编辑问题，并且您的实际程序输出的是缩进的选项列表，中间没有空行。这将是在任何情况下都要遵循的标准。)
一个新的趋势(也许有一个POSIX规范可以解决这个问题?)是消除文档的手册页系统，并将手册页中的所有信息作为程序的一部分—帮助输出包括在内。这个额外的内容将包括更长的描述，解释的概念，使用示例，已知的限制和错误，如何报告错误，以及可能的相关命令的“参见”部分。
我希望这能有所帮助。
微软有自己的命令行标准规范:
This document is focused at developers of command line utilities. Collectively, our goal is to present a consistent, composable command line user experience. Achieving that allows a user to learn a core set of concepts (syntax, naming, behaviors, etc) and then be able to translate that knowledge into working with a large set of commands. Those commands should be able to output standardized streams of data in a standardized format to allow easy composition without the burden of parsing streams of output text. This document is written to be independent of any specific implementation of a shell, set of utilities or command creation technologies; however, Appendix J - Using Windows Powershell to implement the Microsoft Command Line Standard shows how using Windows PowerShell will provide implementation of many of these guidelines for free.
