“False” olan boolean işlev argümanlarına koymak için doğru yorum?

Bazı açık kaynak projelerinden, aşağıdaki kodlama stilini topladım

void someFunction(bool forget);

void ourFunction() {
  someFunction(false /* forget */);
}    

falseBurada ne anlama geldiğinden her zaman şüphem var. "Unut" anlamına mı geliyor, yoksa "unutma" karşılık gelen parametresine mi (yukarıdaki durumda olduğu gibi) atıfta bulunuyor ve "yanlış" ise onu reddetmek anlamına mı geliyor?

En çok hangi stil kullanılır ve belirsizlikten kaçınmanın en iyi yolu (veya daha iyi yollarından bazıları) nedir?

Gönderdiğiniz örnek kodda forget, bir bayrak argümanı gibi görünüyor . (Emin değilim çünkü fonksiyon tamamen varsayımsaldır.)

Bayrak argümanları bir kod kokusudur. Bir işlevin birden fazla şey yaptığını ve iyi bir işlevin sadece bir şey yapması gerektiğini belirtirler.

Bayrak argümanından kaçınmak için, işlevi işlev adındaki farkı açıklayan iki işleve ayırın.

Bayrak argümanı

serveIceCream(bool lowFat)

Bayrak argümanı yok

serveTraditionalIceCream()
serveLowFatIceCream()

edit: İdeal olarak, flag parametresi ile bir fonksiyonun çevresinde kalmanıza gerek yoktur. Ne çizgisinde durumlar vardır Fowler bir dolaşık uygulama çağırır tamamen fonksiyonlarının ayrılması çoğaltılamaz kodunu oluşturur. Bununla birlikte, parametrelenen fonksiyonun siklomatik karmaşıklığı ne kadar yüksek olursa, ondan kurtulma argümanı o kadar güçlüdür.

Layman'ın sözleriyle:

• false bir değişmezdir.
• tam anlamıyla geçiyorsun false
• someFunctionunutmamasını söylüyorsun
• Eğer anlatıyorsun someFunctionparametredir unutmakfalse
• someFunctionhatırlamanı söylüyorsun

Bence işlev böyle olsaydı daha iyi olurdu:

void someFunction(bool remember);

onu arayabilirsin

void ourFunction() {
  someFunction(true);
} 

veya eski adı koruyun ancak sarma işlevinizi şu şekilde değiştirin:

void ourFunctionWithRemember() {
  someFunction(false);
} 

DÜZENLE:

@Vorac'ın belirttiği gibi, her zaman olumlu kelimeler kullanmaya çalışın . Çift olumsuzlama kafa karıştırıcı.

Parametre iyi adlandırılmış olabilir; işlevin adını bilmeden söylemek zor. Ben açıklama işlevinin asıl yazarın yazılmış olduğunu varsayalım ve bu geçen şeyin bir hatırlatma oldu falseiçine someFunctionaraçlarla ama kimse sonradan birlikte geldiğiniz için, ilk bakışta biraz belirsiz.

Pozitif bir değişken adı kullanmak ( Kod Tamamlandı bölümünde önerilmektedir ), bu snippet'in okunmasını kolaylaştıracak en basit değişiklik olabilir;

void someFunction(boolean remember);

sonra ourFunctionolur:

void ourFunction() {
    someFunction(true /* remember */);
}

Bununla birlikte, bir enum kullanmak, işlev çağrısını, bazı destek kodu pahasına, anlaşılmasını daha da kolaylaştırır:

public enum RememberFoo {
    REMEMBER,
    FORGET
}

...

void someFunction(RememberFoo remember);

...

void ourFunction() {
    someFunction(RememberFoo.REMEMBER);
}

Herhangi bir someFunctionnedenden dolayı imzasını değiştiremiyorsanız, geçici bir değişken kullanmak da kodu okumayı kolaylaştırır, kodun insanlar tarafından ayrıştırılmasını kolaylaştırmaktan başka bir nedenden ötürü bir değişken sunarak koşulların basitleştirilmesi gibi .

void someFunction(boolean remember);

...

void ourFunction() {
    boolean remember = false;
    someFunction(remember);
}

Bir bool değeri anlamlı olacak şekilde değişkeni yeniden adlandırın.

Bu, bir işleve argümanları açıklamak için bir açıklama eklemekten bir milyon kat daha iyidir çünkü ad belirsizdir.

Daha açıklayıcı bir adla yerel bir boole oluşturun ve bu değere atayın. Bu şekilde anlam daha açık olacak.

void ourFunction() {
    bool takeAction = false;  /* false means to forget */
    someFunction( takeAction );
}    

Değişkeni yeniden adlandıramazsanız, yorum biraz daha etkileyici olmalıdır:

void ourFunction() {
    /* false means that the method should forget what was requested */
    someFunction( false );
}    

Qt-Style API'lara atıfta bulunduğundan, bu durumdan bahseden iyi bir makale vardır. Orada, Boole Parametre Tuzağı denir ve okumaya değer.

Bunun özü:

1. Boole ihtiyaç duyulmaması için işlevi aşırı yüklemek
2. Bir numaralandırma kullanmak (Esailija'nın önerdiği gibi) en iyisidir

Bu tuhaf bir yorum.

Derleyicinin bakış açısından, someFunction(false /* forget */);aslında someFunction(false);(yorum çıkarılır). Yani, bu hattın yaptığı someFunctionilk (ve sadece) argüman olarak ayarlanmış olarak çağırmaktır false.

/* forget */sadece parametrenin adıdır. Muhtemelen orada olması gerekmeyen hızlı (ve kirli) bir hatırlatmadan başka bir şey değildir. Sadece daha az belirsiz bir parametre adı kullanın ve yoruma hiç ihtiyacınız olmayacak.

Temiz kodun önerilerinden biri , gereksiz yorumlar ¹ sayısını en aza indirgemek (çürümeye yatkın olmaları nedeniyle) ve işlevleri ve yöntemleri düzgün adlandırmaktır.

Bunu takiben, yorumu kaldıracağım. Sonuçta, modern IDE'ler (eclipse gibi), bir fareyi işlevin üzerine getirdiğinizde kodlu bir kutu açar. Kodu görmek belirsizliği ortadan kaldırmalıdır.

¹ Bazı karmaşık kodları yorumlamak sorun değildir.

Açıkça söylemek gerekirse, yorumlar yalan söyleyebilir. Bazı kişi (belki) değişecek çünkü Böylece açıklamaya yorumlarla başvurmadan kodunuzu kendini documenting yapmak her zaman daha iyidir trueetmek falseve yorumu güncelleme değil.

API'yi değiştiremiyorsanız, 2 seçeneğe başvuruyorum

• Açıklamayı, koddan bağımsız olarak her zaman doğru olacak şekilde değiştirin. Bunu sadece bir kez ararsanız, bu iyi bir çözümdür, çünkü belgeyi yerel tutar.

     someFunction (yanlış / * true = unut, yanlış = hatırla * /); `

• #Defines kullanın, özellikle birden çok kez çağırırsanız.

     #define UNUT doğru
     #define REMEMBER yanlış
     birFonksiyon (HATIRLANMASI);

Ben yorum her zaman doğru yapma ile ilgili cevap gibi , ama iyi olsa da bu kod ile temel sorunu özledim düşünüyorum - tam anlamıyla çağrılıyor.

Yöntemleri çağırırken değişmez değerler kullanmaktan kaçınmalısınız. Yerel değişkenler, isteğe bağlı parametreler, adlandırılmış parametreler, numaralandırmalar - bunlardan en iyi nasıl kaçınacağınız dile ve mevcut olana bağlı olacaktır, ancak bunlardan kaçınmaya çalışın. Değişmez değerler vardır, ancak bir anlamı yoktur.

C # 'da, bunu daha net hale getirmek için adlandırılmış parametreleri kullandım

someFunction(forget: false);

Veya enum:

enum Memory { Remember, Forget };

someFunction(Memory.Forget);

Veya aşırı yükler:

someFunctionForget();

Veya polimorfizm ':

var foo = new Elephantine();

foo.someFunction();

Adlandırma, booleanların belirsizliğini her zaman çözmelidir. Ben her zaman boolean 'isThis' veya 'shouldDoThat' gibi bir şey adlandırıyorum, örneğin:

void printTree(Tree tree, bool shouldPrintPretty){ ... }

ve bunun gibi. Ancak başka birinin koduna başvururken, değerleri geçerken yorum bırakmak en iyisidir.