4

スクリプトでパラメーターと引数の使用法テキストをどのように記述すればよいかについて、どういうわけか混乱しています。どこを見てもいつもと違う。特に、引数の記述方法とその構文はさまざまです。

たとえば、ファイル名のフラグを必要とするパラメータの使用法

$0 -f <filename>
$0 [-f filename]
$0 [-f] <filename>
$0 [-f] [filename]
$0 [-f <filename>]
$0 [-f] [<filename>]

たとえば、オプションのパラメーター (-f、-g、-h) の使用法

$0 [-fgh]
$0 [<optional>]
$0 [-[fgh]]
$0 [-<fgh>]
$0 -fgh
$0 -[fgh]

等

これは些細な問題かもしれませんが、構文が常に異なり、実際には別のことを意味する場合もあるため、面倒ですが、規則に従っていないため、わかりません。それについてどう思いますか? また、適切な構文で使用法テキストを書くためのベスト プラクティスは何ですか?

4

1 に答える 1

7

POSIX は、ユーティリティの引数構文の規則を定義しています (奇妙なことに、実際のユーティリティの説明ページ (たとえばand )で行うように、]と 次のグループの間にスペースを入れるのを忘れているようです)。[commandfind

  • [「' ' および ' ' 表記で囲まれた引数またはオプション引数]はオプションであり、省略できます。」結果として、「囲まれていない」(「閉じられていない?」) 引数は必須です。

  • 「多くの場合、実際の値による置換が必要なパラメーターの名前は、アンダースコアが埋め込まれて表示されます。または、パラメーターは次のように表示されます。

    <parameter name>

    "

  • |「' ' 縦棒表記で区切られた引数は相互に排他的です。」
  • 「省略記号 ( " ..." ) は、オプションまたはオペランドの 1 つ以上の出現が許可されていることを示すために使用されます。」
于 2013-06-26T09:24:38.980 に答える