メソッドの引数に名前を付ける変数を定義するのは良い習慣ですか？

読みやすくするために、次のコードのような関数を呼び出すときに一時変数を定義することがよくあります

var preventUndo = true;
doSomething(preventUndo);

これに対するこれの短いバージョンは、

doSomething(true);

しかし、コードに戻ったとき、私はしばしば何をtrue指しているのだろうと思います。この種の難問に慣習はありますか？

変数の説明

あなたのケースは、変数リファクタリングを説明する紹介の例です。要するに、説明変数は厳密に必要なものではありませんが、読みやすさを高めるために、何かに明確な名前を付けることができます。

良質のコードは意図を読者に伝えます。そして、プロの開発者として読みやすさと保守性があなたの一番の目標です。

したがって、お勧めする経験則は次のとおり です。パラメーターの目的がすぐに明らかでない場合は、変数を使用して適切な名前を付けてください。 これは一般的には良い習慣だと思います（悪用​​されない限り）。簡単で不自然な例を次に示します-考慮してください：

editButton.Enabled = (_grid.SelectedRow != null && ((Person)_grid.SelectedRow).Status == PersonStatus.Active);

対わずかに長いが、間違いなく明確：

bool personIsSelected = (_grid.SelectedRow != null);
bool selectedPersonIsEditable = (personIsSelected && ((Person)_grid.SelectedRow).Status == PersonStatus.Active)
editButton.Enabled = (personIsSelected && selectedPersonIsEditable);

ブールパラメータ

実際の例では、APIのブール値がしばしば悪い考えである理由を強調しています。呼び出し側では、何が起こっているのかを説明するために何もしません。考慮してください：

ParseFolder(true, false);

これらのパラメーターの意味を調べる必要があります。それらが列挙型である場合、より明確になります。

ParseFolder(ParseBehaviour.Recursive, CompatibilityOption.Strict);

編集：

見出しを追加し、2つの主要な段落の順序を入れ替えました。これは、あまりにも多くの人がブール値パラメーターの部分に焦点を合わせていたためです（公平に言えば、最初の段落でした）。また、最初の部分に例を追加しました。

必要のないコードを書かないでください。

doSomething(true)理解するのが難しい場合は、コメントを追加する必要があります。

// Do something and prevent the undo.
doSomething(true);

または、言語がサポートしている場合は、パラメーター名を追加します。

doSomething(preventUndo: true);

それ以外の場合は、IDEを使用して、呼び出されたメソッドの署名を取得します。

役に立つ場合

追加の変数を追加すると便利です。

1. デバッグ目的：

   var productId = this.Data.GetLastProductId();
   this.Data.AddToCart(productId);
   

   同じコードを1行で記述できますが、製品IDが正しいかどうかを確認するために製品をカートに追加する前にブレークポイントを配置する場合は、1行ではなく2行を記述することをお勧めします。

2. 多数のパラメーターを持つメソッドがあり、各パラメーターが評価から取得される場合。一行で、これは全く読めなくなるかもしれません。

   // Even with indentation, this is unreadable.
   var doSomething(
       isSomethingElse ? 0 : this.getAValue(),
       this.getAnotherOne() ?? this.default,
       (a + b + c + d + e) * f,
       this.hello ? this.world : (this.hello2 ? this.world2 : -1));
   

3. パラメータの評価が複雑すぎる場合。私が見たコードの例：

   // Wouldn't it be easier to have several if/else's (maybe even in a separate method)?
   do(something ? (hello ? world : -1) : (programmers ? stackexchange : (com ? -1 : 0)));
   

他の場合はなぜですか？

単純な場合に追加の変数を作成しないのはなぜですか？

1. パフォーマンスへの影響のためではありません。これは、自分のアプリを微最適化する初心者開発者の非常に間違った仮定です。コンパイラーは変数をインライン化するため、ほとんどの言語でパフォーマンスへの影響はありません。コンパイラーがそれを行わない言語では、手動でインライン化することで数マイクロ秒の時間がかかる場合がありますが、それは価値がありません。しないでください。

2. ただし、変数に付けた名前をパラメーターの名前に分離するリスクがあるためです。

   例：

   元のコードは次のとおりだとしましょう：

   void doSomething(bool preventUndo)
   {
       // Does something very interesting.
       undoHistory.removeLast();
   }
   
   // Later in code:
   var preventUndo = true;
   doSomething(preventUndo);
   

   後に、開発者はdoSomething最近、元に戻す履歴に2つの新しい方法が導入されたことに気付きました。

   undoHistory.clearAll() { ... }
   undoHistory.disable() { ... }
   

   今、preventUndoあまり明確ではないようです。最後のアクションのみが防止されるということですか？または、ユーザーが元に戻す機能を使用できなくなることを意味するのでしょうか？または、元に戻す履歴がクリアされますか？より明確な名前は次のとおりです。

   doSomething(bool hideLastUndo) { ... }
   doSomething(bool removeAllUndo) { ... }
   doSomething(bool disableUndoFeature) { ... }
   

   だから今、あなたは持っています：

   void doSomething(bool hideLastUndo)
   {
       // Does something very interesting.
       undoHistory.removeLast();
   }
   
   // Later in code, very error prone, while the signature of the method is clear:
   var preventUndo = true;
   doSomething(preventUndo);
   

列挙型はどうですか？

列挙型を使用することを提案した人もいました。差し迫った問題を解決する一方で、より大きな問題を作成します。見てみましょう：

enum undoPrevention
{
    keepInHistory,
    prevent,
}

void doSomething(undoPrevention preventUndo)
{
    doTheJob();
    if (preventUndo == undoPrevention.prevent)
    {
        this.undoHistory.discardLastEntry();
    }
}

doSomething(undoPrevention.prevent);

それに関する問題：

1. コードが多すぎます。if (preventUndo == undoPrevention.prevent)？マジ？私はそのようなものをif毎回書きたくありません。

2. 同じ列挙型を別の場所で使用している場合、列挙型に要素を追加するのは非常に魅力的です。このように変更した場合はどうなりますか：

   enum undoPrevention
   {
       keepInHistory,
       prevent,
       keepButDisable, // Keeps the entry in the history, but makes it disabled.
   }
   

   これからどうなりますか？ウィルdoSomething方法作業は予想通り？これを防ぐには、最初からこの方法でこのメソッドを記述する必要があります。

   void doSomething(undoPrevention preventUndo)
   {
       if (![undoPrevention.keepInHistory, undoPrevention.prevent].contains(preventUndo))
       {
           throw new ArgumentException('preventUndo');
       }
   
       doTheJob();
       if (preventUndo == undoPrevention.prevent)
       {
           this.undoHistory.discardLastEntry();
       }
   }
   

   ブール値を使用するバリアントは、見栄えがし始めます！

   void doSomething(bool preventUndo)
   {
       doTheJob();
       if (preventUndo)
       {
           this.undoHistory.discardLastEntry();
       }
   }
   

また、ブールフラグを使用してメソッドを記述しないでください。

ロバートC.マーティンは、彼の著書Clean Code（ISBN-13 978-0-13-235088-4）で、「ブール値を関数に渡すことは本当にひどい習慣だ」と言っています。

彼を言い換えると、真/偽の切り替えがあるという事実は、メソッドが2つの異なること（つまり、「元に戻す」と「元に戻す」を行う）を行う可能性が高いことを意味しているため、 2つの異なるメソッドに分割されます（内部的に同じものを呼び出す場合があります）。

DoSomething()
{...

DoSomethingUndoable()
{....

2つのクラスを見て、それらがどのように結合されているかを見ると、カテゴリの 1つはデータ結合です。これは、あるクラスのコードを別のクラスのメソッドを呼び出し、レポートを何月にしたいかなどのデータを渡すだけですカテゴリは、コントロールの結合、メソッドの呼び出し、メソッドの動作を制御する何かの受け渡しです。クラスで使用する例はverboseフラグまたはreportTypeフラグですが、これpreventUndoも素晴らしい例です。既に説明したように、制御の結合により、呼び出し元のコードを読み取り、何が起こっているのかを理解することが難しくなります。またdoSomething()、同じフラグを使用して元に戻すとアーカイブの両方を制御したり、別のパラメータを追加したりすることで、呼び出しコードを変更に対して脆弱にしますdoSomething() アーカイブを制御し、コードを壊すなど。

問題は、コードが密結合しすぎていることです。動作を制御するためにブールを渡すことは、私の意見では、悪いAPIの兆候です。APIを所有している場合は、変更してください。2つの方法、doSomething()およびのdoSomethingWithUndo()方が適しています。所有していない場合は、所有するコードで2つのラッパーメソッドを自分で記述し、そのうちの1つを呼び出しdoSomething(true)、もう1つを呼び出しますdoSomething(false)。

引数の役割を定義するのは、呼び出し側の役割ではありません。私はいつもインラインバージョンに行き、疑問がある場合は呼び出された関数の署名を確認します。

変数は、現在のスコープ内での役割に基づいて名前を付ける必要があります。Notが送信されるスコープ。

JavaScriptで私がすることは、関数が次のような唯一のパラメーターとしてオブジェクトを取ることです。

function doSomething(settings) {
    var preventUndo = settings.hasOwnProperty('preventUndo') ? settings.preventUndo : false;
    // Deal with preventUndo in the normal way.
}

次に、それを呼び出します：

doSomething({preventUndo: true});

私は、言語機能を活用して自分自身を明確にするのが好きです。たとえば、C＃では、名前でパラメーターを指定できます。

 CallSomething(name: "So and so", age: 12, description: "A random person.");

JavaScriptでは、通常、この理由から引数としてオプションオブジェクトを使用することを好みます。

function doSomething(args) { /*...*/ }

doSomething({ name: 'So and so', age: 12, description: 'A random person.' });

それは私の好みだけです。呼び出されるメソッド、および開発者が署名を理解するのにIDEがどのように役立つかに大きく依存すると思います。

これが最も簡単で読みやすいと思います。

enum Undo { ALLOW, PREVENT }

doSomething(Undo u) {
    if (Undo.ALLOW == u) {
        // save stuff to undo later.
    }
    // do your thing
}

doSomething(Undo.ALLOW);

MainMaはそれを好みません。私たちは同意しないことに同意する必要がある場合があります。または、Joshua Blochが提案するソリューションを使用できます。

enum Undo {
    ALLOW {
        @Override
        public void createUndoBuffer() {
            // put undo code here
        }
    },
    PREVENT {
        @Override
        public void createUndoBuffer() {
            // do nothing
        }
    };

    public abstract void createUndoBuffer();
}

doSomething(Undo u) {
    u.createUndoBuffer();
    // do your thing
}

これで、Undo.LIMITED_UNDOを追加した場合、createUndoBuffer（）メソッドを実装しない限り、コードはコンパイルされません。また、doSomething（）にはif（Undo.ALLOW == u）はありません。私は両方の方法でそれを行いました。2番目の方法はかなり重く、Undo列挙型がページやコードのページに展開されるときに理解するのが少し難しいですが、それはあなたに考えさせます。通常、単純なメソッドを使用して、変更する理由があるまで単純なブール値を2値の列挙型に置き換えます。3番目の値を追加するとき、IDEを使用して「使用方法を検索」し、すべてを修正します。

あなたのソリューションはあなたのコードをもう少し読みやすくすると思いますが、関数呼び出しをより明確にするために余分な変数を定義することは避けたいと思います。また、追加の変数を使用する場合は、プログラミング言語でサポートされていれば、定数としてマークします。

余分な変数を含まない2つの選択肢を考えることができます。

1.追加のコメントを使用する

doSomething(/* preventUndo */ true);

2.ブール値の代わりに2値の列挙を使用します

enum Options
{
    PreventUndo,
    ...
}

...

doSomething(PreventUndo);

言語が列挙型をサポートしている場合、代替2を使用できます。

編集

もちろん、名前付き引数を使用することも、言語でサポートされている場合はオプションです。

列挙型が必要とする余分なコーディングに関しては、本当に無視できるように思えます。の代わりに

if (preventUndo)
{
    ...
}

あなたが持っている

if (undoOption == PreventUndo)
{
    ...
}

または

switch (undoOption)
{
  case PreventUndo:
  ...
}

そして、もう少し入力する場合でも、コードは1回書かれて何度も読み取られることを忘れないでください。そのため、6か月後に読みやすいコードを見つけるためにもう少し入力する価値があります。

@GlenPetersonが言ったことに同意します。

doSomething(Undo.ALLOW); // call using a self evident enum

しかし、私には2つの可能性（trueまたはfalse）しかないと思われるため、insterestingは次のようになります

//Two methods    

doSomething()  // this method does something but doesn't prevent undo

doSomethingPreventUndo() // this method does something and prevents undo

あなたは主にjavascriptについて尋ねているので、coffeescriptを使用することで、構文のような名前付き引数を持つことができます。

# declare method, ={} declares a default value to prevent null reference errors
doSomething = ({preventUndo} = {}) ->
  if preventUndo
    undo = no
  else
    undo = yes

#call method
doSomething preventUndo: yes
#or 
doSomething(preventUndo: yes)

にコンパイルする

var doSomething;

doSomething = function(_arg) {
  var preventUndo, undo;
  preventUndo = (_arg != null ? _arg : {}).preventUndo;
  if (preventUndo) {
    return undo = false;
  } else {
    return undo = true;
  }
};

doSomething({
  preventUndo: true
});

doSomething({
  preventUndo: true
});

http://js2coffee.org/でいくつかの可能性を試してみてください

あまり一般的ではない解決策であり、OPがJavascriptに言及しているため、値のマッピングに連想配列を使用する可能性があります。単一のブール値よりも優れている点は、引数を好きなだけ持つことができ、それらのシーケンスについて心配する必要がないことです。

var doSomethingOptions = new Array();

doSomethingOptions["PREVENTUNDO"] = true;
doSomethingOptions["TESTMODE"] = false;

doSomething( doSomethingOptions );

// ...

function doSomething( doSomethingOptions ){
    // Check for null here
    if( doSomethingOptions["PREVENTUNDO"] ) // ...
}

これは強い型付けのバックグラウンドを持つ人の反射であり、それほど実用的ではないかもしれませんが、独創性のためにこれを考慮してください。

別の可能性はオブジェクトを持つことであり、Javascriptでも可能です。私はこれが完全に正しいと100％確信していません。さらにインスピレーションを得るには、Factoryなどのパターンをご覧ください。

function SomethingDoer( preventUndo ) {
    this.preventUndo = preventUndo;
    this.doSomething = function() {
            if( this.preventUndo ){
                    // ...
            }
    };
}

mySomethingDoer = new SomethingDoer(true).doSomething();

あなたの質問と他の答えの焦点は、関数が呼び出される場所で読みやすさを改善することです。これは私が同意する焦点です。イベント「ブール引数なし」という特定のガイドラインは、常にこの目的のための手段として機能し、自分自身になったり終了したりすることはありません。

プログラミング言語がC＃4やPythonのように名前付き引数/キーワード引数をサポートしている場合、またはSmalltalkやObjective-Cのようにメソッド引数がメソッド名にインターリーブされている場合、この問題はほとんど回避されることに注意すると便利だと思います。

例：

// C# 4
foo.doSomething(preventUndo: true);

# Python
foo.doSomething(preventUndo=True)

// Objective-C
[foo doSomethingWith:bar shouldPreventUndo:YES];

ブール変数を関数の引数として渡すことは避けてください。関数は一度に1つのことを行う必要があるためです。ブール変数を渡すことにより、関数には2つの動作があります。また、これにより、後の段階で、またはコードを見る傾向がある他のプログラマーにとって、読みやすさの問題が生じます。これは、関数のテストにも問題を引き起こします。おそらくこの場合、2つのテストケースを作成する必要があります。switchステートメントを取得し、switchタイプに基づいてその動作を変更する関数がある場合、非常に多くの異なるテストケースを定義する必要があると想像してください。

関数のブール引数を持つことに出くわすたびに、ブール引数をまったく書かないようにコードを微調整する必要があります。

int preventUndo = true;
doSomething(preventUndo);

C ++などの低ラベル言語向けの優れたコンパイラは、以下のように2行以上のマシンコードを最適化します。

doSomething(true); 

そのため、パフォーマンスには関係ありませんが、読みやすさが向上します。

また、変数が後で変数になり、他の値も受け入れる場合に備えて、変数を使用すると便利です。