2

読みやすさと一貫性のために、コマンド ライン アプリからのコンソール出力をフォーマットする規則はありますか? たとえば、サブ情報をインデントしますか、いつ空白行を印刷しますか、重要なステートメントにどのようにアクセントを付ける必要がありますか。

私は、出力がすぐに混沌としたぼかしに劣化する可能性があることを発見しました。他の人が何をしているのか興味があります。

更新:実際には、これはデバッグ ステータスを端末に吐き出す組み込みソフトウェア用ですが、コンソール アプリによく似ており、誰もがそれに慣れていると思いました。これまでありがとう。

4

2 に答える 2

1

私は次の 2 種類のプログラムを区別します。

スクリプトで使用される可能性のある情報を出力しますか(つまり、解析可能である必要があります)? 次に、かなり厳密な形式を定義し、それのみを使用します (たとえば、固定フィールド区切り文字)。

スクリプトで解析する必要のない情報を出力しますか (または、スクリプトで解析可能な別の形式が既にありますか)? 次に、当然のことを書きます。

私の提案:

  • 読みたいと思うように書く
  • サブ情報を 2 つまたは 4 つのスペースでインデントします。
  • 情報のブロックは最大で 1 つの空行で区切られます
  • COLUMN環境変数を尊重します(ROWS出力に適用される場合は可能です)。
于 2008-12-22T19:19:53.753 に答える
1

これが *nix 環境の場合は、Basics of Unix Philosophy を読むことをお勧めします。これは出力に固有のものではありませんが、一般的なコマンド ライン プログラムに適したガイドラインがいくつかあります。

すべてのプログラムの出力が、まだ知られていない別のプログラムへの入力になることを期待してください。無関係な情報で出力を乱雑にしないでください。列形式またはバイナリ形式の入力形式は厳密に避けてください。インタラクティブな入力に固執しないでください。

于 2008-12-22T19:58:53.957 に答える