在我看来,每个人对于如何编写概要描述最终用户的命令用法都有自己的想法。
例如,这是来自的格式man grep
:
grep [OPTIONS] PATTERN [FILE...]
grep [OPTIONS] [-e PATTERN | -f FILE] [FILE...]
现在,它的某些语法出现在其他手册页中。 []
被认为是可选的,并且...
对于同一输入的倍数有意义。
但是人们使用“ |
或” /
作为“或”,还有其他人会颠倒[]
含义。或他们没有给出任何指示[OPTIONS]
。
我想遵循我写的标准,但是我浏览的每个网站都会告诉我一些不同的东西。
有没有编写提要的实际标准方法,或者约定是人们长期以来所做的事情?
选择一个并坚持下去。
—
凯文(Kevin)
出于某种原因,我认为这无济于事。每个人都有自己的标准,然后就什么也做不了。
—
托米斯特”,2014年
是的,这正是我想要的。谢谢。
—
托米斯特”,2014年
@MarkPlotnick-我将其设为A,以便OP可以接受它。如果有的话,那就是标准。参考illuminÉ引用的链接。
—
slm