<分区>
我设计了一些具有 CLI 的程序,并希望尽可能将它们记录为标准。是否有关于执行此操作的最佳方法的任何协议(protocol)?
一个例子:
假设程序是“sayHello”,它有几个参数:名称和消息。所以一个标准的调用看起来像这样:
> sayHello "Bob" "You look great"
好的,所以我的命令用法看起来像这样:
sayHello [name] [message]
如果括号在使用命令中具有特定含义,那可能已经是一个错误。但让我们更进一步,说“消息”是可选的:
sayHello [name] [message (optional)]
然后还有一个问题,如果有一个我们想要表示的默认值怎么办:
sayHello [name] [message (optional: default 'you look good')]
我意识到这个用法声明在这一点上看起来有点迟钝。我真的想问是否有关于如何编写这些内容的公认标准。我偷偷怀疑括号和方括号都有特定的含义。