Question

我设计了一些具有CLI的程序，并希望将它们作为标准记录。那里有关于最佳方法的协议吗？

一个例子：

让我们说该计划是＆＃34; sayHello＆＃34;它需要一些参数：名称和消息。所以标准调用看起来像这样：

> sayHello "Bob" "You look great"

好的，所以我的命令用法看起来像这样：

sayHello [name] [message]

如果括号在使用命令中具有特定含义，那可能已经是错误了。但是，让我们更进一步说“＃34; message＆＃34;是可选的：

sayHello [name] [message (optional)]

再过一次皱纹，如果我们想要表示默认值，那该怎么办：

sayHello [name] [message (optional: default 'you look good')]

我意识到这个用法语句在这一点看起来有些迟钝。我真的在问如果有关于如何编写这些标准的商定标准。我怀疑括号和括号都有特定的含义。

Answer 1

虽然我不知道任何官方标准，但仍有一些努力来提供逐个框架的约定。 Docopt就是这样一个框架，可能适合您的需求。用他们自己的话说：

docopt可以帮助您：

定义命令行应用的界面，
自动为其生成解析器。

many programming languages有一些实现，包括shell。

Answer 2

您可能需要查看常见Unix命令的手册（例如man grep）或Windows命令的帮助文档（例如find /?）并将其用作一般指南。如果您选择了这些模式中的任何一种（或使用了两者共有的一些元素），那么您至少会让最少数量的人感到惊讶。

Apache commons在some包中也有classes commons-cli，它将打印您的特定命令行选项集的使用信息。

Options options = new Options();
options.addOption(OptionBuilder.withLongOpt("file")
                      .withDescription("The file to be processed")
                      .hasArg()
                      .withArgName("FILE")
                      .isRequired()
                      .create('f'));
options.addOption(OptionBuilder.withLongOpt("version")
                      .withDescription("Print the version of the application")
                      .create('v'));
options.addOption(OptionBuilder.withLongOpt("help").create('h'));

String header = "Do something useful with an input file\n\n";
String footer = "\nPlease report issues at http://example.com/issues";

HelpFormatter formatter = new HelpFormatter();
formatter.printHelp("myapp", header, options, footer, true);

使用上面的内容将生成如下所示的帮助输出：

usage: myapp -f  [-h] [-v]
Do something useful with an input file

 -f,--file <FILE>   The file to be processed
 -h,--help
 -v,--version       Print the version of the application

Please report issues at http://example.com/issues

记录命令行界面是否有最佳实践？

2 个答案: