私は現在、up
usingを呼び出すときにコマンドラインに使用法文字列を表示するシェルスクリプトを作業しています--help
。出力は次のとおりです。
$ up --help
usage: up [-n levels][--help][--versions][basename]...
--help
これは良く見えますが、ディスプレイと--version
オプションは広く受け入れられている標準であり、文字列の使用にノイズのみを追加するように見えるので、実際に必要なのだろうか。
答え1
完全にあなた次第ですが、ほとんどのプログラムはこれを行います。
program --help
Usage: program [<options>][<arguments> ...]
Options:
--help show this message, then exit
--something after some spaces for alignment, an explenation follows.
あなたはそれを確認する必要があります選択項目のインポートほとんどのプログラム(プログラミング言語でも利用可能)とスクリプトで使用されます。これにより、スクリプトを使用している人が混乱しないようになります。
最後に追加すべき事項みんなそれはあなたに些細なように見えますが、あなたの選択です。したがって、使用法のオプションセクションに--helpと--versionを追加します。