documentation - 命令行选项文档标准

Question

关闭。这个问题不满足Stack Overflow guidelines .它目前不接受答案。












想改善这个问题吗？更新问题，使其成为 on-topic对于堆栈溢出。

3年前关闭。




Improve this question




我经常破解一些 Thor、Rake、Bash 甚至 PHP 命令行工具。我想以一致的方式记录命令行参数和变体。

此文档是否有官方或推荐的标准？

比如当一个选项是可选的[--foo=bar]，或者当一个选项可以是一个 n 值(“是|否”)等等。

我宁愿不提出自己的标准，因为有官方(POSIX？)标准或指南已经列出了在 CLI 上记录工具和应用程序的注意事项。

Answer 1

我不确定您的输出格式是什么，但为什么不使用 man-page风格？它似乎非常适合命令行工具。