返された変数に「result」という名前を付けるのは良い習慣ですか？[閉まっている]

メソッドが返す変数を変数名で呼び出すのは良い習慣resultですか？

例えば：

public Zorglub calculate() {
    Zorglub result = [...]
    [...]
    return result;
}

または、タイプ別に名前を付ける必要がありますか？

public Zorglub calculate() {
    Zorglub zorglub = [...]
    [...]
    return zorglub;
}

私は両方を野生で見ましたが、どちらかを選択する必要がある場合、前者または後者（またはより良い名前）を好む理由は何ですか？

私は主にJavaについて考えています。

これがメソッド変数である場合、実際には可読性に依存します。

変数の宣言とメソッドの戻り値の型の両方に既に型名があるので、使用するresultこともできます-変数の役割を説明しています。

変数の名前がの場合、相互読み取りが容易になりますresult。これにより、意図が明確になります。

戻り変数が必要な場合（実際にはめったに起こりません）、私は常にそれretを呼び出し、常に関数ヘッドのすぐ下で定義します。関数にはすでに名前があり、返されるものについてすべてを示しています。

私が持っている場合はmyFunction、私は可能性があり、それの戻り変数に名前をmyFunctionReturnValueまったく同じことを言って、私だけは、明示的に毎回それを言う必要があるだろう。通常、関数は短くする必要があるため、そのような明示性は必要ありません。そして、たとえ道に迷ったとしても、宣言にジャンプして、関数定義のすぐ下に着地します。

しかし、暗黙的に（retまたはのようにresult）または明示的に（myFunctionReturnValueまたはのようにmyFunctionResult）状態でない、これが現在の関数の戻り変数であるその他の名前は、あまりにも一般的です。

2番目の例でzorglubは、ひどい選択です。宣言は、変数の名前が名前のすぐ隣にある型注釈に等しいという変数を作成したということだけです。int someIntまたはとほぼ同じくらい役立ちますZorglub z。

最初の例では、コードを見ると、この関数がを計算することを示す関数名が最初に表示されますZorglub。2行目を読むと、「わかりました、ここに返されるzorglubがありますが、すぐには返せないので、result変数に格納されているようです」（補足として：値を再割り当てするつもりはないので、それを伝えるために変数finalを宣言するのが最善です）、「返される前に何が起こるか見てみましょう」と思います。最初の例とは異なり、これが変数であること、それが返されること、そしてそれを理解したい場合は関数本体をフォローすることを知るために、実際にそれ以上読む必要はありません。

Spartan Programmingを読んでみてください。これはあなたの質問にかなり関連しています。

2番目の例では、結果のタイプをそれが何であるかと混同しています。

Zorglub zorglub;

ゾーグルブだと二度言います メソッドの戻り値の型を読み取るのが面倒な場合は3回。しかしながら、

double variance;

たとえば、プログラムのセマンティクスの観点から、戻り値の意味についての手がかりを与えてくれます。resultメソッドのサイズに応じて、単に呼び出すよりも明確である場合と明確でない場合があります。これは、各メソッドIMOの判定呼び出しです。

あなたがプレイする場合、多くのZorglubがあなたのメソッド内のオブジェクトを、あなたはミスを犯すと、間違ったものを返す、または/および、あなたは他の人に名前を付けるように誘惑することができ、「可能性」zorglub1、zorglub2など、

名前を付けた場合result、そのような間違いをする可能性はありません。さらに、それは良い名前だと思います。また、私は見てきたreturnedValueか、returnedObject少し長いが、それはまた明らかだ、数回。

私は個人的にresult変数名として使用することに完全に満足していません。結構なことですが、関連する値は何らかの計算の結果であることを教えてくれますが、プログラムで使用される変数/フィールドの約90％（またはそれ以上）に当てはまると思います。

さらに、他のいくつかの回答が指摘したように、メソッド/関数から返される値をマークするために使用できます。ただし、メソッドを短くし、1つのことだけを行い、単一レベルの抽象化に一貫してとどまる場合、ローカル変数はあまり多くなく、メソッドが返すものを確認するのは簡単です。

そのため、メソッドを短く簡潔に保ち、変数に名前を付けて、囲んでいるメソッド内でのローカルロールではなく、保持する値の意味を表現することを好みます。ただし、（たとえば、レガシーコードの場合）の方Zorglub resultが確かに理解しやすいかもしれませんZorglub zorglub。

私は個人的にresult関数/メソッドから返される値の名前を使用しています。返される値であることを明示します。同じタイプの変数が複数存在する可能性があるため、タイプごとに名前を付けることは有用ではないようです。

違いは何ですか？同じことをする2つの異なる単語があるので、本当の問題はどちらがより明確に聞こえますか？

「結果」または「ゾルグルブ」。

私はZorglubResultスターターに使用して、結果があなたが持っているかもしれない他の結果とあなたが見ることができるその結果と比較するのがより Zorglub簡単であることを見るのを好むでしょう。

タイプ別に名前を付ける必要がありますか？

いいえ。これは、Systems Hungarianと呼ばれ、必要なときに変数の型を表示できるプログラムを使用するという考えにより、時代遅れになっています。

コードで何かに名前を付ける必要があるときはいつでも、わかりやすく、意味があり、読みやすい名前を付ける必要があります。戻り値変数の場合は、ネーミングに慣れる傾向がある場所の特に良い例です。

明確に名前が付けられた関数があり、1行のコードのみが必要な場合は、命名を完全にスキップできます。メソッドを短く、単一の目的にすることは、常にあなたが目指すべき理想です。ただし、場合によっては、数行のコードで関数を完了する必要があります。そのような場合、関数の目的に合わせて変数に名前を付けることを常にお勧めします。

関数の目的が計算または決定アルゴリズムの結果を返すことである場合result、変数が使用するのに完全に適切な名前ですが、関数がリストから項目を返す場合はどうでしょうか？関数が数学やリストとは関係のない他の目的に役立っている場合はどうなりますか？そのような場合は、関数が作成された理由に関連する意味のある名前を変数に指定することをお勧めします。もちろん、他の名前と衝突する可能性が低い名前なので、必要に応じて単に結果を使用できますが、読みやすさの観点からは、より意味のあるコンテキストで変数に名前を付ける方が理にかなっています。

私はそれらを組み合わせるのが好きで、それが何であり、返されることを意図していることを示しています。

あなたの例ではresultZorglubになります

結果が（resultStringではなく）単なるものであるよりも実際に重要でない場合

ある時点で戻り値を設定してから、条件を使用してそれを変更する可能性のあるすべてのコードをスキップすることと、returnすぐに実行することとの間に大きな違いは見られないため、直接戻りに行くため、result変数はありません。

条件付きコードによって変更される場合と変更されない場合がある中間値がある場合、それは結果ではありません（まだ）。

私がC ++で作業していたときに、Javaでこれが当てはまると思います。

例えば

int Width() const
{
    Requires(....);
    Requires(....);

    //calculation

    Ensures(...);
    Ensures(...);
    return Result;
}

確認ブロックはメソッドの最後にある必要があるため、これは契約による設計です。しかし、リターンは最後でなければなりません。確認ブロックに続くことができるのは、結果を返すというルールのみでした。

再帰関数では、多くの場合、結果をステップごとに運び、末尾呼び出しの最適化を行うことが効果的です。ユーザーにパラメーターを提供する必要がないことを知らせるには、パラメーターに「result」という名前を付けるのが妥当です。

def removeOccurence [A] (slice: Seq[A], original: Seq[A]) = {
  @scala.annotation.tailrec
  def remove (leftOriginal: Seq[A], result: Seq[A]) : Seq[A] =
    trimStart (slice, leftOriginal) match {
      case (h :: tail) => remove (tail, h +: result)
      case (Nil)       => result.reverse
    }
    remove (original, Nil)
}

しかし、多くの場合、「キャリー」と「これまで」を使用します。これらは、ほとんどの場合、野外で見たものであり、アイディアが少し良くなっています。

もちろん、2番目の理由は、算術評価を行う場合など、トピックが「結果」という単語を示唆している場合です。数式を解析し、変数を値に置き換え、最終的に結果を計算します。

3番目の理由はすでに述べましたが、私は少し逸脱しています：何らかの仕事を実行するメソッドを記述します。たとえば、 '' max ''の形式を評価するとしましょう。

def max = {
  val result = somethingElseToDo
  if (foo) result else default 
}

結果 '' result ''を呼び出す代わりに、 '' max ''と呼ぶこともできますが、一部の言語ではメソッドを呼び出すときに括弧を省略できるため、maxはメソッド自体の再帰呼び出しになります。

一般的に、結果が何であるかを示す名前を好むでしょう。ただし、GUIフィールド、文字列表現、数値、データベース用の1つがあるため、別の名前を使用すると、混乱の可能性が高くなります。3から7行の短い方法では、「結果」は名前の問題ではないはずです。

Object Pascalでは、これは選択肢ではありません。Result関数のコード内のどこかに変数に値を割り当てる必要があります。

例：

function AddIntegers( A,B: Integer): Integer;
begin
  Result := A + B; 
end; 

だから私にとっては、戻り値を受け取るための「結果」（または、言語の予約語との名前の競合を避けるためにポルトガル語で綴る「レトルノ」）変数がかなり自然です。

当然ですが、C派生言語での非常に単純な式であれば、結果変数を宣言する必要はありません-式を直接返します。

結果に名前を付けるだけでなく（「r」に特化しています）、その使用方法も同じです。たとえば、戻り変数を使用する場合、すべてのreturnステートメントがそれを返す必要があります。'return r;'はありません。最後に、メソッド/関数全体に「return m * x + b;」のようなものを振りかけますuse "r = m * x + b; 代わりにreturn r; "

結果は良好です。変数名が目的を果たすように、一目でコードを理解することができます。