問題タブ [usage-message]

アプリケーションの「使用法」を印刷する場合、stdoutまたはstderrのどちらで実行する必要がありますか？

アプリケーションにもよりますが、いくつかのケースを見てきましたが、1つのルールはないようです。たぶん私は間違っていて、1つの良い習慣があります。その場合、それは何ですか？

Mathematica8のCombinatoricaパッケージを見ると、関数の定義が見つかります。私が知りたいのは、Mathematica が使用法メッセージをフォーマットする方法をどのように知っているかということです。正しいファイルを見ていないというメッセージが表示されます。いずれにせよ、次のことを試してみましょう。(mathematicapath)/AddOns/LegacyPackages/DiscreteMath/Combinatorica.m

この行は、上記のファイルの 682 行です。これを Mathematica ノートブックで実行して使用?Cofactorすると、まったく同じメッセージが表示されます。しかし、パッケージを取得すると、メッセージはフォーマットされます。スクリーンショットは次のとおりです。

関数内の m、i、j がどのように変更され、メッセージに二重矢印が追加されたかに注意してください。ドキュメントが存在するため、メッセージに矢印が追加されたと思います。誰かがこの動作を説明できますか?

編集: これは、m ファイルに自動保存されるノートブック ファイルのスクリーンショットです。

ご覧のとおり、LとMは斜体の新ローマ時代です。次に、パッケージをロードして使用法を確認します。

ここまでは順調ですね。次に、ドキュメンテーション センターを見てみましょう。関数を探しますLineDistance。

ご覧のとおり、奇妙なメッセージが表示されます。この場合、スタイルなしでメッセージを表示したいだけです。Combinatoricaパッケージがこれをどのように行うのかまだわかりません。これに従って、ドキュメント センターが概要を表示できるようにインデックスを作成しました。概要は、基本的に使用状況の表示です。もっと具体的に言う必要がある場合はお知らせください。

私は、多くのコマンドライン引数とフラグを急速に取得しているコンソールアプリケーションを書いています。このため、ユーザーがこれらのフラグの説明とそれらが果たす目的にアクセスできるようにしたいと思います。

私が考えることができるいくつかの可能な解決策があります

• READMEファイルを作成して、実行可能ファイルと同じディレクトリに貼り付けることができます。利点はシンプルでポータブルですが、欠点は誰かがファイルを簡単に削除/編集できることです。

• メッセージ全体をプログラム内の変数に貼り付けて、ユーザーが入力したときなどに画面に出力することができますmycmd --help。利点は、実行可能ファイルにとどまり、編集できないことです。欠点は、以下のようなものが浮かんでいるため、コードにあります。

  /li>

• プログラムのエントリを作成することはできmanますが、アプリケーションはWindowsとLinuxでほぼ同じように使用されるため、これはあまり移植性がありません。

質問はおそらく好みの問題だと思いますが、過去に人々が使用したことを考えていなかった他の解決策があるかどうかだけ興味がありました。

理想的には、開発者（現時点では私）が編集して更新し続けるのは簡単ですが、他の人が実際にそれを台無しにすることはできないものです。

私はいくつかのコマンド ライン パラメーターを取得し、argparse を使用して使用法メッセージを表示する必要がある小さな Python プログラムに取り組んでいます。私はこれらの2行を持っています

そして要件は、ユーザーにこのメッセージを表示することです:

ただし、ユーザーに表示するのは-

[-r R]を[-r ROW]に (そして同じ方法で[-c C]を[-c COLUMNS]に) 変換するにはどうすればよいですか?

私はargsparseのドキュメントをかなり見ましたが、役に立ちませんでした...