首页
学习
活动
专区
工具
TVP
发布
社区首页 >问答首页 >命令行/shell帮助文本是否有“标准”格式?

命令行/shell帮助文本是否有“标准”格式?
EN

Stack Overflow用户
提问于 2012-03-16 02:14:04
回答 4查看 139.9K关注 0票数 302

如果没有,有没有一个事实上的标准?基本上,我是这样编写命令行帮助文本的:

代码语言:javascript
复制
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

我基本上是通过阅读各种工具的帮助文本来实现的,但是有没有指南之类的列表呢?例如,我应该使用方括号还是圆括号?如何使用空格?如果参数是一个列表呢?谢谢!

EN

回答 4

Stack Overflow用户

发布于 2014-09-13 02:22:48

看看docopt吧。它是记录(并自动解析)命令行参数的正式标准。

例如..。

代码语言:javascript
复制
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>...
票数 115
EN

Stack Overflow用户

发布于 2012-03-16 02:29:42

GNU编码标准是此类事情的一个很好的参考。This section处理--help的输出。在这种情况下,它并不是非常具体。打印一个显示短选项和长选项以及简洁描述的表格可能不会出错。尽量使所有参数之间的间距正确,以提高可读性。您可能希望为您的工具提供一个man页面(可能还有一本info手册),以提供更详细的解释。

票数 11
EN

Stack Overflow用户

发布于 2012-03-16 02:30:08

是的,你在正确的轨道上。

是的,方括号通常是可选项目的指示器。

通常,正如您已经勾勒出来的,在顶部有一个命令行摘要,后面是详细信息,理想情况下是每个选项的示例。(您的示例显示了每个选项描述之间的行,但我假设这是一个编辑问题,并且您的实际程序输出缩进的选项列表,中间没有空行。这将是任何情况下都要遵循的标准。)

一种更新的趋势(可能有一个POSIX规范解决了这个问题?)是文档的手册页系统的消除,并将手册页中的所有信息都包含在program --help输出中。这个额外的部分将包括更长的描述,解释的概念,使用示例,已知的限制和错误,如何报告错误,以及可能的相关命令的“请参阅”部分。

我希望这能帮到你。

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/9725675

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档