そうでない場合、事実上の標準はありますか? 基本的に、次のようなコマンド ライン ヘルプ テキストを書いています。
usage: app_name [options] required_input required_input2
options:
-a, --argument Does something
-b required Does something with "required"
-c, --command required Something else
-d [optlistitem1 optlistitem 2 ... ] Something with list
基本的にはさまざまなツールのヘルプ テキストを読んで作成したのですが、ガイドラインのリストなどはありますか? たとえば、角括弧と丸括弧のどちらを使用すればよいですか? スペースの使用方法は? 引数がリストの場合はどうなりますか?
ベストアンサー1
通常、ヘルプ出力には次の内容が含まれます。
- アプリの機能の説明
- 使用構文:
[options]オプションがどこにあるかを示すために使用しますarg_name必須の単数引数の場合[arg_name]オプションの単数引数の場合arg_name...必須引数が複数存在する場合（これはまれです）[arg_name...]任意の数値を指定できる引数の場合arg_name説明的で短い名前を小文字のスネークケースで記述する必要があることに注意してください
- それぞれが適切にフォーマットされたオプションのリストです。
- 短い説明がある
- デフォルト値がある場合はそれを表示する
- 該当する場合は、可能な値を表示する
- オプションが短い形式（例
-l）または長い形式（例--list）を受け入れることができる場合は、それらの説明が同じになるため、同じ行に一緒に含めることに注意してください。
- コマンドライン引数のソースとなる可能性のある設定ファイルまたは環境変数の場所の簡単なインジケータ、例：
GREP_OPTS - マニュアルページがある場合はその旨を記載し、ない場合はより詳細なヘルプが見つかる場所を簡単に示します。
-hさらに、両方を受け入れ--helpてこのメッセージをトリガーすることが良い形式であり、ユーザーがコマンドライン構文を間違えた場合、たとえば必要な引数を省略した場合にこのメッセージを表示する必要があることに注意してください。