java - 如何使用 jcommander 打印帮助？

Question

如何使用jcommander打印帮助？

我找不到这方面的 API。

Answer 1

找到这个小片段以显示应用程序帮助。为了简单，一切都在一节课上完成。

public class JCommanderExample {

    @Parameter(names = "-debug", description = "Debug mode")
    private boolean debug = false;

    @Parameter(names = "--help", help = true)
    private boolean help = false;

    public static void main(String[] args) {
        JCommanderExample jct = new JCommanderExample();
        JCommander jCommander = new JCommander(jct, args);
        jCommander.setProgramName("JCommanderExample");
        if (jct.help) {
            jCommander.usage();
            return;
        }
        System.out.println("your logic goes here");
    }
}

如果您使用参数运行代码段，--help则输出将是

Usage: JCommanderExample [options]
  Options:
        --help

       Default: false
    -debug
       Debug mode
       Default: false

Answer 2

使用较新版本的 JCommander，您需要创建 JCommander 的实例化。

例如主要是：

public class Usage {
  public static void main(String...argv) {
    Args args = new Args();
    JCommander jct = JCommander.newBuilder().addObject(args).build();
    jct.parse(argv);
    if (args.isHelp()) {
         jct.usage();
    }
  }
}

使用这样的 Args 类（如果您没有在 Main 中定义参数）：

import com.beust.jcommander.Parameter;
import com.beust.jcommander.Parameters;

public class Args {

 @Parameter(names = { "--help", "-h" }, help = true)
 private boolean help = false;

 public boolean isHelp() {
    return help;
 }
}