命令行选项文档的标准

时间:2012-09-29 12:27:45

标签: documentation command-line-arguments

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

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

就像选项是可选的[ - foo = bar],或者当一个选项可以是一个n值(“yes | no”)时,etceteras。

当有一个官方(POSIX?)标准或指南已经列出了这些标准或者没有用于在CLI上记录工具和应用程序时,我宁愿不提出我自己的标准。

1 个答案:

答案 0 :(得分:1)

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