Yudi Maryanto Blog

Setelah kita memilih tipe exception yang akan kita lontarkan, maka sekarang kita akan mencoba membahas tentang bagaimana merancanag pesan kesalahan yang akan dibawa sebuah exception sehingga ia bisa membawa informasi yang berguna bagi pengguna. Berikut ini paduannya:

Lakukan:
Buat teks pesan kesalahan yang jelas. Pesan ini harus menjelaskan sebab terjadinya exception serta menjelaskan pula apa yang diperlukan untuk menghindari exception tersebut.

Catatan: Sebagai desainer framework, maka target kita adalah developer. Karena itu informasi tersebut cenderung bersifat teknis. Namun jika kita sedang menulis kode di level aplikasi, maka target kita adalah pengguna. Dalam kasus ini, maka pesan kesalahan harus membuat pemakai merasa nyaman (tidak terlalu teknis) tetapi dengan tidak mengorbankan keakuratan informasi tersebut (Kita tidak boleh membohongi pemakai).

Lakukan:
Pastikan bahwa pesan yang dibawa sebuah exception sudah benar secara gramatika.

Exception handler yang paling atas bisa menampilkan pesan kesalahan ini kepada pengguna.

Lakukan:
Pastikan bahwa setiap kalimat pada pesan kesalahan diakhiri dengan tanda titik.

Hindari:
penggunaan tanda tanya dan tanda seru pada pesan kesalahan.

Jangan:
Menampilkan informasi sensitif di dalam pesan kesalahan (misalnya username dan password).

Pertimbangkan:
untuk melakukan localizing pada pesan kesalahan jika komponen yang kita buat akan digunakan oleh developer yang berada di negara lain dan berbicara dengan bahasa yang berbeda dengan bahasa kita.