2017-07-26 14 views
0

命名変数が最も複雑なソフトウェア工学の問題の1つであると私たちが知っている人は、あなたが直面するまでそれを理解していないようです。二重の複数形を含む変数または引数の名前を付ける方法は?

実際の例の現在のジレンマ:テスト実行の一部として生成されたファイルの形式でユーザーが指定できるCLIパラメータを追加する。

ほとんどの場合、単一の形式で生成されるファイルは1つだけですが、複数のファイルを取得し、コマンド分離リスト(--controversial-param=junitxml,htmlなど)を使用して複数の出力形式を要求できる場合は、周りに行ってきました名前に基づいて

が、私は勝者がこのパターンに一致したものだろうということな印象まで来た:彼らは文法的に正しくないため

--(output|report|result)[s]?-format[s]? 

私は二重の複数形を使用しないことを主張しています。

2つ目の理由は、(一般的に)混乱の原因となります。誰かがパラメータを追加して複数を追加したり、コードレビューに合格したり、マージしたりするのを忘れてしまいます。私はこの種のエラーを過去に何度も見たことがあり、たとえ "タイプミス"をしたり、レビュープロセス中にそれを見逃したりしていました。

だから私は提案して投票するために他のSOコミュニティに頼って解決策。最良の議論が勝つようにし、個人の好みの代わりに推論を使用する。人気(Googleの検索結果)に基づいて

+0

頭痛与えることができますが、複数の値を渡していたすべての出力ファイルが指定された_all_形式で生成されることを意味ですか?もしそうなら、この場合、あなたは思ったより簡単です: '--output-formats'は完璧です。単語" output "は何もないファイルから何かに多くのファイルを表すことができます。ゼロまたは単一形式を含む。 二重の複数形が本当に必要な場合や、アポストロフィを使用できないことが頭痛を与える場合があります。 – gbr

+0

@gbrそれを答えてください! – sorin

+0

ここにいるのは...。 – gbr

答えて

0

と私は全く

--output-format 

ん複数形を提案していないだろうが、コマンドにアクセスする他のツールとの以前の経験が--helpを使用している場合、これは、文書化されて、リストを分離しました。

0

あなたのパラメータに複数の値を渡すと、すべての出力ファイルが指定されたすべての形式で生成されることを意味している場合、この場合には、それはあなたが思うより簡単です:

--output-formatsは完全に罰金です、単語「出力何もないものから何本ものファイルまで何でも表すことができ、 "書式"には、ゼロまたは単一の書式を含めることができます。

あり、二重複数形が本当に必要とされるであろう時に、他の例であるとアポストロフィを使用するために不可能はあなたが

関連する問題