多字命令行参数的样式指南规则?

问题描述 投票:0回答:1

有谁知道任何命令行界面风格指南,其中包含有关如何呈现多字选项的规则?

有很多品种可能。

许多程序(例如

grep
)使用两个连字符前缀和连字符分隔符。例如:

--byte-offset

某些程序(例如

find
)使用一个连字符前缀和下划线分隔符。例如:

-ignore_readdir_race

某些程序(例如

java
)使用一个连字符前缀和冒号分隔符。例如:

-verbose:gc

一些程序使用两个连字符前缀和下划线分隔符。我还没有找到一个常见的例子,但我的公司有使用这种风格的内部实用程序。例如:

--save_only

有些程序甚至支持多种品种。

GNU Coding StandardsThe Art of Unix Usability 是很好的参考资料,但我没有具体看到有关多字选项的信息。

我正在寻找专门解决多字选项的命令行界面样式指南的链接。我不在乎这些指南提供什么规则或建议,只要它们提到多词选项即可。

command-line-interface
1个回答
6
投票

GNU 建议对多字参数使用连字符分隔符,如

--byte-offset

您可能会发现 libc 手册及其有关程序参数语法约定的章节很有用。与您的问题相关的片段是:

GNU 在这些约定中添加了长选项。长选项包括 “--”后跟由字母数字字符和破折号组成的名称。 选项名称通常为一到三个单词长,并用连字符表示 单独的单词。用户可以缩写选项名称,只要 缩写是独一无二的。

© www.soinside.com 2019 - 2024. All rights reserved.