Bir yöntem varsa

bool DoStuff() {
    try {
        // doing stuff...
        return true;
    }
    catch (SomeSpecificException ex) {
        return false;
    }
}

daha çok aranmalı IsStuffDone()mı?

Her iki isim de kullanıcı tarafından yanlış yorumlanabilir: Eğer isim buysa, DoStuff()neden bir boole döndürüyor? Adı IsStuffDone()açıksa, yöntemin bir görevi yerine getirip getirmediği veya yalnızca sonucunu kontrol edip etmediği açık değildir.

Bu dava için bir kongre var mı? Veya alternatif bir yaklaşım, bu kusurlu olarak kabul edilir? Örneğin, C # gibi çıktı parametrelerine sahip dillerde, bir boolean durum değişkeni, yönteme bir yöntem olarak iletilebilir ve yöntemin dönüş türü olur void.

EDIT: Özel sorunumda istisna işleme doğrudan arayan kişiye devredilemez, çünkü yöntem bir arayüz uygulamasının bir parçasıdır. Bu nedenle, arayan, farklı uygulamaların tüm istisnalarıyla uğraşmakla suçlanamaz. Bu istisnalara aşina değil. Ancak, arayan kişi, npinti'nin cevabında ve yorumundaStuffHasNotBeenDoneForSomeReasonException önerildiği gibi özel bir istisna ile ilgilenebilir .

.NET'te, bir tanesinin bir istisna ( DoStuff) atabileceği sıklıkla yöntem çiftleriniz vardır , diğerinde bir Boole durumu ve başarılı bir yürütme sırasında, bir out parametresi ( TryDoStuff) üzerinden gerçek sonuç döndürülür .

(Microsoft buna "Try-Parse Pattern" adını verir , çünkü belki de en belirgin örneği TryParseçeşitli ilkel türlerin yöntemleridir.)

Eğer Tryönek kendi dilinizde nadir olduğunu, buna genelde kullanmamalısınız.

Arama koduna istisnayı basitçe attıysanız ne olur?

Bu şekilde, kodunuzu kimlerin kullandığı konusunda istisna işlemeyi size bırakıyorsunuz. Peki, gelecekte aşağıdakileri yapmak istiyorsanız:

• İstisnalar atılmazsa, A eylemine geçin
• (Örneğin) a FileNotFoundExceptionatılırsa, B eylemini yapın
• Başka bir istisna atılırsa, C işlemine geçin

İstisnalarınızı geri atarsanız, yukarıdaki değişiklik basit bir şekilde ekstra bir catchblok eklemek anlamına gelir. Bunu olduğu gibi bırakırsanız, projenin karmaşıklığına bağlı olarak birden fazla konumda olabilen yöntemi ve yöntemin çağrıldığı yeri değiştirmeniz gerekecektir.

DoStuff() bu yeterlidir ve işlevin döndüren değeri belgelenmelidir ve mevcut birçok API'yi arayarak, işlev adından bahsetmenize gerek yoktur:

PHP

// this method update and return the number affected rows 
// called update instead of updateAndGetAffectedCount
$affected = $query->update(/* values */);

Cı-Sharp

// Remove item from the List
// returns true if item is successfully removed; otherwise, false.
public bool Remove( T item )

Java'da, Koleksiyon API'si bir boole döndüren bir ekleme yöntemi tanımlar . Temel olarak, toplama işleminin değişip değişmediğini döndürür. Öyleyse, bir Listöğe için eklendiğinden beri, genellikle doğru dönecektir, bir öğe için Set, eğer zaten orada olsaydı, Sether benzersiz öğeye en fazla bir kez izin verildiğinden yanlış dönebilir .

Bununla birlikte, koleksiyon tarafından izin verilmeyen bir öğeyi, örneğin null değerini eklerseniz, ekleme, NullPointerExceptionfalse döndürmek yerine atmaya başlar .

Davanıza aynı mantığı uyguladığınızda, neden bir boole döndürmeniz gerekiyor? Bir istisna saklamaksa, yapma. Sadece istisna at. Bu şekilde neyin yanlış gittiğini görebilirsiniz. Bir boole gereksiniminiz varsa, yapılmadığı için, bir istisna dışında bir nedenden ötürü DoStuff(), bu davranışı temsil ettiği için yöntemi adlandırın . Bir şeyler yapar.

Olabilir, farklı nedenlerle başarısız olabilir, İstisna, normal koşullar, bu yüzden şunu kullanır:

boolean doStuff() - returns true when successful

Önemli olan, booleanın ne demek olduğunu belgelemek.

Genelde yöntemleri bir OperationResult(veya OperationResult<T>) döndürür ve IsSuccessözelliği OperationResultuygun şekilde ayarlarım . Eğer 'usual' metodu geçersizse geri dönün OperationResult, 'usual' metodu bir nesneyi döndürürse geri dönün OperationResult<T>ve Itemözelliği OperationResultuygun şekilde ayarlayın. Ben de üzerinde yöntemleri sahip öneririm OperationResultgibi .Failed(string reason)ve .Succeeded(T item). OperationResultSistemlerinizde hızlı bir şekilde tanıdık bir tür haline gelir ve geliştiriciler nasıl kullanılacağını bilir.

Bu gerçekten kullandığınız dile bağlıdır. Bazı dillerde olduğu gibi, pek çok dilde veya hiçbir şekilde bulunmayan sözleşmeler ve protokoller vardır.

Örneğin, Objective-C dilinde ve iOS / Mac OS X SDK yöntemlerinin adları genellikle aşağıdaki satırlar boyunca gider:

- (returndatatype) viewDidLoad {
- (returndatatype) isVisible {
- (returndatatype) appendMessage:datatype variablename with:datatype variablename {

Gördüğünüz gibi, orada viewDidLoad adında bir yöntem var. Ne zaman kendi uygulamalarımı yaparsam bu tür isimleri kullanmayı tercih ederim. Bu, söylediğiniz gibi bir şey olup olmadığını kontrol etmek için kullanılabilir. Yöntemlerine isim verdiğin şey hakkında çok derin düşündüğüne inanıyorum. Çoğu yöntem ne olursa olsun yaptıklarının durumunu döndürür, örnek alın:

PHP'de, bağlantı başarısız olursa mysql_connect () işlevi false döndürür. Yapacağını söylemiyor, ama yapıyor ve belgeler onun programcıya yanlış yorumlanamayacağını söylüyor.

'Dene' öneki kullanılmasını önermek istiyorum. Bu, yöntemin başarılı olabileceği veya olamayacağı durumlar için iyi bilinen bir kalıptır. Bu adlandırma modeli, Microsoft tarafından .NET Framework'te kullanılmıştır (örneğin, TryParseInt).

Ama, belki de bu isimle ilgili değil. Metodunuzun giriş / çıkış parametrelerini nasıl tasarladığınızla ilgilidir.

Benim fikrim, bir yöntemin bir dönüş değeri varsa, o zaman bu yöntemi çağırmanın amacı, bu dönüş değerini elde etmek olmalıdır. Bu nedenle, bir işlemin durumunu belirtmek için dönüş türünü kullanmaktan kaçınmalısınız.

C #, bir out parametresi kullanmayı tercih ederim. Bir çıkış kullanarak parametreyi bir yan parametre olarak işaretliyorum. Özellikle C # 6 satır içi değişken bildirimini destekleyecektir.

DoStuff(out var isStuffDone); // The out parameter name clearly states its purpose.
DoStuff(out var _); // I use _ for naming parameters that I am ignoring.

Yöntemin birincil rolünü temel alan bir isim seçerdim. Bu yöntemin boolean değeri döndürmesi, 'Is' ön ekini zorunlu kılmaz. Oldukça genişletilebilir olan 'Is' ön ekini kullanan bazı Java kodları bulalım. Bir bak java.io.File.delete(). Dönüyor boolean, ancak çağrılmadı isFileDeleted(). Bunun nedeni, yöntemin birincil rolünün bir dosyayı silmek olmasıdır. Birisi bu yöntemi bir dosyayı silmek amacıyla çağırır.

Boolean, sadece çalışmanın sonucunu geri göndermek için var. Öte yandan görelim java.util.Map.isEmpty(). Açıkçası, koleksiyonun boş olup olmadığını bulmak için böyle bir yöntem çağırıyorsunuz. Hiçbir şeyin yapılmasını istemiyorsun. Siz sadece mevcut durumun ne olduğunu öğrenmek istiyorsunuz.

Yani şahsen, kesinlikle yapışırdım DoStuff().

Bu benim için biraz önemli bir konu. Çoğu zaman eski kodları koruduğumda, şahsen "yalan söyleme yöntemi" olarak adlandırdığım bir şeyin üzerine rastlarım. Ad, A eylemini öneriyor, ancak vücut B eylemini yapıyor. Veritabanındaki verileri değiştiren bir alıcı yöntemine ilişkin en tuhaf örnek.