Tbpgr Blog

Ruby プログラマ tbpgr(てぃーびー) のブログ

Ruby | CLI | Be Helpful | Documenting Options

概要

書籍 Build Awesome Command-Line Applications in Ruby2

Be Helpful

詳細

各フラグ、スイッチに1センテンスの短い要約を記述します。
端末で折り返さない程度の長さにします。(60文字以内)

フラグが引数をとる場合は、短い単語で記述する。
(もし複数単語からなる場合は、アンダースコアで区切る)
フラグにデフォルト値があるなら、ヘルプに記載しておく。

OptionParser, GLI, Thorなどを利用した場合は、
基本的なフォーマットはサポートしてくれるので
より少ない記述量で済みます。