0
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 5 years have passed since last update.

コマンドラインツール作成時のオプション/引数設定ガイドライン

0
Posted at

ターミナルとかで動く軽いツールをサクッと作るときに機能が増えてくると
そういえばオプションってどうゆう書式やったっけってひとのための忘備録(Windows、Linux)
Macはようわかりません(多分Linuxと同じ)。

一般的なアレ

コマンド名 [--option1] [--option2=オプション引数] [--option3 オプション引数] 引数1 引数2
  • オプションは引数の前に書くほうが良い(作るときは普通、最後や真ん中に入れても動くようにする)。
  • オプションを表す記号は、Windowsでは/、Linuxでは---。最近は、Windowsであっても---に合わせることが多い。理由はLinuxではスラッシュが使えないから。
  • Windows:よく使うと思われるオプションは省略形を用意する(例:/res/resource/?/help)。
  • Linux:オプションはふつう1文字。--を使うときのみ、2文字以上。例:-h--help-v--version。すべてのオプションにおいて、この2パターンを両方用意すべき。
  • 各オプションは、省略してあっても動くようにする。引数はふつう入力必須。
  • オプション引数については、=でつなぐか、空白を1個あけて続けて書く。前者の場合、=の前後に空白を入れてはならない。
  • -で始まるオプションは繋げれる(例:-a -b -c-abc)

特殊なオプション

/?(/help)[-h(--help)]/ver(/version)[-v(--version)]は、必ず用意するもの。

  • これらがコマンドのどこかに含まれていると、ヘルプまたはバージョンの出力をして終了する(それ以外の動作はしない)。

とりあえず

Linuxにあわせませう。

0
1
2

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?