命令行工具的 usage 有什么编写规范吗

2017-01-16 16:12:41 +08:00
 FindHao

有没有一个统一的规范写法?

4131 次点击
所在节点    编程
1 条回复
Kilerd
2017-01-16 16:35:26 +08:00
简单地 google 了下 “ the standard of program usage ” or "the standard of cli help"

给几个感觉可以的链接:
http://stackoverflow.com/questions/9725675/is-there-a-standard-format-for-command-line-shell-help-text
http://courses.cms.caltech.edu/cs11/material/general/usage.html
https://technet.microsoft.com/en-us/library/ee156811.aspx 这是微软的标准

其实这个并不用自己写,很多优秀的库都支持自动生成这个 help 信息

Python 中的 Click , Rust 中的 Clap

这些都是你在程序中定义了变量或者 subcommand 之后会自动生成 --help 或者 -h 里面的内容。

如果说要看规范的化,建议查查 RFC 文档。

不过强烈建议先看看自己写的语言里面有没有类似的库,有就没必要手写了。

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/334930

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX