Döndürülen değişkeni "sonuç" olarak adlandırmak iyi bir uygulama mıdır? [kapalı]

Bir yöntemin döndürdüğü değişken ismini değişken ismiyle çağırmak iyi bir uygulama mıdır result?

Örneğin:

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

Yoksa türüne göre adlandırmalı mıyım?

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

Her ikisini de vahşi doğada gördüm, birini seçmem gerekirse, ilkini veya ikincisini (veya daha iyi bir ismi) tercih etmem için hangi nedenler olabilir?

Ben çoğunlukla Java'yı düşünüyorum.

Bu bir metod değişkeni ise, gerçekten okunabilirliğe bağlıdır.

Hem değişken bildiriminde hem de yöntem dönüş türünde zaten bir tür adınız olduğunu görünce, siz de kullanabilirsiniz result- bu değişkenin rolünü açıklayıcıdır.

Değişken isimlendirilirse çapraz okuma daha kolay yapılır result. Bu, niyetini açıkça gösterir.

Eğer bir dönüş değişkenine ihtiyacım olursa (bu aslında nadiren olur), daima onu çağırırım retve daima fonksiyon başlığının hemen altında tanımlarım. İşlev zaten döndüğü ile ilgili her şeyi söyleyen bir ada sahip.

Ben varsa myFunctionben olabilir 's dönüş değişkeni isim myFunctionReturnValuede aynı şeyi söylemek, sadece ben açıkça her zaman bunu söylemek gerekir. İşlevler genellikle kısa olması gerektiğinden, bu açıklığa gerek yoktur. İzini kaybedersem bile bildirime atlayabilirim ve işlev tanımının hemen altına inerim.

Ancak, dolaylı olarak (gibi retveya result) veya açıkça (gibi myFunctionReturnValueveya myFunctionResult) belirtmeyen başka herhangi bir ad, bunun geçerli işlevlerin dönüş değişkeninin çok genel olduğunu belirtir.

İkinci örneğinde zorglubkorkunç bir seçim. Tüm bildiri, bana, isminin hemen yanında bulunan açıklama tipine eşit olan bir değişken yarattığınızı söylüyor. Bu int someIntya da kadar faydalı Zorglub z.

İlk örneğinizde, koda baktığımda, önce bu ismin hesaplandığını söyleyen işlev adını gördüm Zorglub. İkinci satırı okuduğumda, "tamam, işte zorglub, iadesi olacak, ama açıkça geri döndürülemiyor ve bu nedenle resultdeğişkende saklanıyor " (bir not olarak: değeri yeniden atamayacaksınız, o zaman en son değişkeni bildirmek için en iyisini belirtmelisiniz), ve sonra sanırım "şimdi dönmeden önce ona ne olacağını görelim". İlk örnekte aksine aslında bilmek bundan da fazla okumak gerekmez bu iade edilecek gidiyor değişken, ve ben bunu anlamak istiyorsanız fonksiyon vücutta takip etmek istiyorum.

Sorunuzla ilgili olan Spartalı Programlama hakkında okumak isteyebilirsiniz .

İkinci örneğinizde, sonucun türünü ne olduğu ile karıştırıyorsunuz .

Zorglub zorglub;

Sadece bana iki kere bir Zorglub olduğunu söyledi. Metod dönüş tipini okumak için uğraşıyorsam üç kere. Ancak,

double variance;

örneğin, bana neyi dönüş değeri hakkında bir ipucu verir araçlarının programı semantik açısından. resultYöntemin boyutuna bağlı olarak, sadece onu çağırmaktan daha açık bir ifadesi olabilir veya olmayabilir - bu, her bir IMO yöntemi için bir yargılama çağrısıdır.

Eğer Zorglub sizin yöntemlerinde nesneleri birçok ile oynamak, bir hata yaparsanız ve yanlış bir dönüş, ve / veya başkalarına isim cazip olabilir "olabilir" zorglub1, zorglub2vb

Eğer adını resultverirseniz, böyle bir hata yapma şansınız yoktur. Artı, bunun iyi bir isim olduğunu düşünüyorum; Ben de gördüm returnedValueya da returnedObjectbirkaç kez, biraz uzun da olsa net.

Ben şahsen resultdeğişken isim olarak kullanmaktan tamamen emin değilim . Yeterince adil, ilgili değerin bazı hesaplamaların sonucu olduğunu söylüyor - ancak bunun bir programda kullanılan değişkenlerin / alanların yaklaşık% 90'ına (veya daha fazla) doğru olduğunu tahmin ediyorum.

Ayrıca, birkaç başka cevabın da belirtildiği gibi, bir yöntemden / fonksiyondan döndürülecek değeri işaretlemek için kullanılabilir. Ancak, yöntemlerimi kısa tutarsam, yalnızca bir şeyi yapmaya ve sürekli olarak tek bir soyutlama düzeyinde kalmaya odaklanırsam, çok fazla yerel değişkenim olmayacak ve bir yöntemin geri döneceğini görmek önemsiz olacak.

Bu yüzden metotlarımı kısa ve temiz tutmayı tercih ediyorum ve değişkenlerimin isimlendirme metodundaki yerel rolü yerine, sahip oldukları değerin anlamını ifade etmek için isimlendirmeyi tercih ediyorum . Ancak, (örneğin eski kodda) Zorglub resultkesinlikle anlaması daha kolay olabilir Zorglub zorglub.

resultİşlev / yöntemden döndürülecek değerin ismini şahsen kullanırım . Döndürülecek değer olduğunu açıkça belirtiyor. Türüne göre adlandırmak işe yaramıyor çünkü aynı tipte birden fazla değişken olabilir.

Fark ne? orada sadece 2 farklı kelime var, aynı şeyi yapacak yani asıl sorun hangisinin size daha net geldiği?

"Sonuç" veya "zorglub".

Sonuçların elde edebileceğiniz diğer sonuçlarla karşılaştırılmasının daha kolay ZorglubResultolduğunu ve sonuç olarak gördüğünüz sonucu görmek için bir başlangıç yapmayı tercih ederim Zorglub.

türüne göre adlandırmalı mıyım?

Hayır asla. Buna Macarca Sistem adı verilir ve ihtiyaç duyduğunuzda herhangi bir değişkenin türünü görüntüleyebilecek bir program kullanma fikri önemsiz biçimde eskidir.

Kodda herhangi bir şeyi adlandırmanız gerektiğinde, açıklayıcı, anlamlı ve okunabilir adlar sağlamanız gerekir. Bir geri dönüş değişkeni söz konusu olduğunda, insanların adlandırma konusunda endişeli olma eğiliminde olduklarının iyi bir örneği vardır.

Açıkça adlandırılmış bir işleve sahipseniz ve yalnızca tek bir kod satırına ihtiyacınız varsa, adı tamamen atlayabilirsiniz. Yöntemlerinizi kısa ve tek bir amaç haline getirmek, her zaman hedef almanız gereken idealdir. Bununla birlikte, bazen birkaç kod satırı içeren bir işlevi tamamlamanız gerekebilir. Bu gibi durumlarda, işlevin amacına uygun değişkeni adlandırmanız her zaman tavsiye edilir.

Eğer işlevin amacı bir hesaplama veya karar algoritmasının sonucunu döndürmekse, resultdeğişkeninizin kullanması için mükemmel bir addır, fakat ya işleviniz bir listeden bir öğe döndürüyorsa? İşleviniz matematikle veya listelerle ilgisi olmayan başka bir amaca hizmet ediyorsa? Bu gibi durumlarda, değişkene, fonksiyonun neden yaratıldığına ilişkin anlamlı bir isim vermek daha iyidir. Elbette, eğer istersen, başka bir şeyle çakışması muhtemel olmayan bir isim, çünkü okunabilirlik perspektifinden değişkenine daha anlamlı ve bağlamsal bir isim vermek daha mantıklı olur.

Onları birleştirmeyi seviyorum, ne olduğunu ve iade edilmek istendiğini gösteriyor.

yani örneğinizde sonuçZorglub olurdu

Eğer gerçekten ne olduğu önemli değil, sadece sonuçtan daha önemliyse (resultString değil)

Bir noktada bir dönüş değeri ayarlamak ve sonra onu değiştirebilecek tüm kodları atlamak için koşullu kullanmak ile hemen kullanmak arasında bir fark göremiyorum return, bu yüzden doğrudan dönüş için gidiyorum, dolayısıyla resultdeğişken yok .

Koşullu kodla değiştirilebilecek veya değiştirilemeyecek bir ara değeriniz varsa, o zaman bir sonuç (henüz) değildir, bu nedenle kesinlikle adlandırılmaması gerekir.

C ++ 'da çalışırken ve sanırım Java'da da geçerli olabilir.

Örneğin

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

    //calculation

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

Bu, garantinin yöntemin sonunda olması gerektiği için sözleşmeyle tasarlanır. Ancak dönüş son olmalı. Sonuç bloğunu sağlamak için, mutlak bloğu takip edebilecek tek şey buydu.

Özyinelemeli bir işlevde, bir kuyruk çağrısı optimizasyonu yapmak için sonucu adım adım adım taşımak etkilidir. Kullanıcıya bir parametre sağlamaya gerek olmadığını belirtmek için, bir "sonuç" parametresinin adlandırılması makul olabilir:

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)
}

Ancak daha çok, vahşi doğada gördüğüm ve fikri çoğu zaman daha da iyi taşıyan “taşıma” ve “sofar” kullanıyorum.

Elbette, ikinci bir neden, eğer konunuz '' sonuç '' kelimesini önerirse, örneğin, aritmetik değerlendirme yaparsanız. Formülü ayrıştırabilir, değişkenleri değerlerle değiştirebilir ve sonunda bir sonuç hesaplayabilirsiniz.

Üçüncü bir neden daha önce belirtildi, ancak küçük bir sapma var: Bir iş yapan bir yöntem yazıyorsunuz, diyelim ki '' max '' şeklini değerlendirdiğini diyelim.

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

'' Sonuç '' sonucunu çağırmak yerine '' max '' diyebiliriz, ancak bazı dillerde bir yöntem çağrılırken parantezi ihmal edebilirsiniz, bu nedenle max yöntemin kendisine tekrarlı bir çağrı olacaktır.

Genelde sonucun ne olduğunu söyleyen bir ismi tercih ederdim. Fakat eğer bu isim zaten birden fazla değişken, öznitelik veya metot tarafından alınmışsa, bir GUI alanı olduğundan, bir dize temsili, sayısal ve bir diğeri veritabanı için, bir diğeri kullanmak karışıklık olasılığını arttırır. 3 ila 7 satırlık kısa yöntemlerde, '' sonuç '' bir isim için sorun olmamalıdır.

Nesne Pascal'da bu bir seçim değildir. Resultİşlevin kodundaki bir yere değişkene değer atamanız gerekir .

Örnek:

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

Bu yüzden benim için oldukça doğal bir dönüş değeri almak için bir "Sonuç" (veya "Retorno", dilin ayrılmış sözcükleriyle isim çakışmasından kaçınmak için Portekizce'yi hecelediğim için) var.

Tabii ki, eğer C'den türetilmiş bir dilde çok basit bir ifade ise, bir sonuç değişkeni bildirmekle uğraşmayacağım - ifadeyi doğrudan geri döndürmek.

Sadece sonucu ne adlandırdığınla değil ('r' ye özgüdür), ama aynı zamanda nasıl kullanıldığı. örneğin, bir dönüş değişkenine sahip olacaksanız, her return ifadesi bunu döndürmelidir. 'return r;' yok sonunda, ancak yöntem / işlev boyunca 'return m * x + b; "gibi şeyler serpin." r = m * x + b; yerine r; "dön.

sonuç iyi. İlk bakışta kodu anlayabiliyorum, böylece değişken ismi bu amaca hizmet etti.