Kapan "Coba" seharusnya digunakan dalam nama metode C #?

Kami sedang berdiskusi dengan rekan kerja kami tentang apa artinya jika nama metode dimulai dengan "Coba".

Ada beberapa pendapat berikut:

• Gunakan "Coba" ketika metode dapat mengembalikan nilai nol.
• Gunakan "Coba" ketika metode tidak akan melempar pengecualian.

Apa definisi resmi? Apa yang "Coba" katakan dalam nama metode? Apakah ada pedoman resmi tentang ini?

Ini dikenal sebagai pola TryParse dan telah didokumentasikan oleh Microsoft. Halaman Pengecualian dan Kinerja MSDN resmi mengatakan :

Pertimbangkan pola TryParse untuk anggota yang dapat melempar pengecualian dalam skenario umum untuk menghindari masalah kinerja yang terkait dengan pengecualian.

Jadi, jika Anda memiliki kode yang menggunakan case biasa berarti bahwa ia mungkin mengeluarkan pengecualian (seperti parsing int), pola TryParse masuk akal.

(Dikoreksi) Ada pedoman resmi, seperti yang disarankan Erik.

Ketika saya melihat TrySomethingmetode, saya menganggapnya

• tidak melempar
• kembali bool
• jika saya mengharapkan nilai, itu dikembalikan melalui parameter 'keluar'
• ada Somethingmetode, yang memungkinkan saya untuk menangani pengecualian apa pun sendiri. (sunting, disarankan oleh Jesse Webb)

Saya pikir Anda harus menggunakan tryketika Anda ingin melanjutkan. Tidak masalah bahwa suatu metode mengembalikan beberapa nilai atau tidak.

Kasus 1: jika kembali baik, Anda dapat melanjutkan dengan beberapa cara.

Kasus 2: jika tidak kembali: masih baik; Anda dapat melanjutkan dengan cara lain.

Dan jika Anda mengharapkan beberapa nilai sebagai output dari metode itu maka gunakan outparameter tersebut.

Contoh

int value
if (dictionary.TryGetValue("key", out value))
{
    // Proceed in some way
}
else
{
    // Proceed in some other way
}

Anda harus menggunakan "Coba" dalam nama metode, ketika Anda ingin memanifestasikan fakta bahwa metode invokation dapat menghasilkan hasil yang tidak valid. Mengikuti standar. NET itu, omong-omong, bukan fungsi yang menimbulkan pengecualian, tetapi fungsi yang mengembalikan beberapa VALIDatauNON_VALID , dari perspektif program, nilai.

Pada akhirnya, ini semua tentang konvensi penamaan yang Anda putuskan untuk digunakan dalam grup Anda.

Pastikan tryAnda memasukkan nama metode Anda jika:

• Anda tidak membuang pengecualian
• metode Anda memiliki tanda tangan berikut: bool TrySomething(input, out yourReturn)

Jadi pada dasarnya jika kita gunakan try -metode kita hanya mendapatkan hasil boolean kembali.

Jadi kode berikut tidak akan memberikan pengecualian:

string input = "blabla";
int number;
if (int.TryParse(input, out number))
{
// wooohooo we got an int!
} else
{
//dooh!
}

Sedangkan kode ini dapat (dan dalam hal ini akan) memberikan pengecualian:

string input = "blabla";
int number;
try
{
     number = int.Parse(input); //throws an exception
}
catch (Exception)
{
     //dooh!
}

Menggunakan metode Coba adalah cara yang lebih aman dan lebih defensif untuk kode. Cuplikan kode # 2 membutuhkan lebih banyak kinerja untuk dijalankan jika bukan bilangan bulat.

Paman Bob memberikan contoh di bawah ini dalam bukunya Clean Code . Setiap kali kami mengharapkan pengecualian dilemparkan, kami dapat menggunakan Tryawalan ke nama metode:

public void sendShutDown()
{
    try{
        tryToShutDown();
    } catch (DeviceShutDownError e) {
        logger.log(e);            
    }
}

Dan kemudian (diadaptasi):

private void tryToShutDown()
{
    //some code with no error handling, but
    //something might go wrong here
}

The tryToShutDownMetode tidak membuat penanganan kesalahan, karena itulah tanggung jawab sendShutDownmetode.

The TryParsepola Microsoft melanggar pedoman kode yang bersih yang mengatakan bahwa kita harus menghindari parameter output.

Jika kami tidak mengembangkan versi baru C #, kami tidak harus mematuhi semua pedoman Microsoft. Terkadang mereka bukan yang terbaik.