Apa prinsip yang paling mengejutkan?

Dalam pemrograman apa yang disebut Principle of Least Astonishment? Bagaimana konsep ini terkait dengan merancang API yang baik? Apakah ini sesuatu yang berlaku hanya untuk pemrograman berorientasi objek atau apakah itu merasuki teknik pemrograman lain juga? Apakah ini terkait dengan prinsip "melakukan satu hal dalam metode Anda dan melakukannya dengan baik"?

Prinsip Terkecil Leasing berlaku untuk berbagai kegiatan desain - dan tidak hanya dalam komputasi (meskipun sering kali hal-hal yang paling menakjubkan terjadi).

Pertimbangkan lift dengan tombol di sebelahnya yang bertuliskan "panggilan". Saat Anda menekan tombol, telepon umum berdering (alih-alih memanggil lift ke lantai itu). Ini akan dianggap mencengangkan. Desain yang benar adalah dengan meletakkan tombol panggilan di samping telepon daripada lift.

Selanjutnya, pikirkan halaman web yang memiliki jendela pop up yang menampilkan kesalahan gaya windows dengan tombol 'ok' di atasnya. Orang mengklik tombol 'ok' berpikir itu untuk sistem operasi dan bukannya pergi ke halaman web lain. Ini mengejutkan pengguna.

Ketika datang ke API ...

• Pikirkan tentang metode toString () yang alih-alih mencetak bidang mengembalikan kembali "untuk diterapkan".
• Metode equals () yang berfungsi pada informasi tersembunyi.
• Kadang-kadang orang mencoba mengimplementasikan kelas daftar yang diurutkan dengan mengubah metode add to call sort () pada array sesudahnya - yang mencengangkan karena metode add seharusnya ditambahkan ke daftar - ini terutama mencengangkan ketika seseorang kembali ke objek Daftar tanpa pengetahuan bahwa di suatu tempat jauh di dalam, seseorang melanggar kontrak antarmuka.

Memiliki metode yang melakukan satu hal berbeda berkontribusi pada pengurangan keheranan, namun ini adalah prinsip terpisah dalam desain API. Keempat prinsip yang sering disebut-sebut sebagai "desain API yang baik" adalah (dari pdf ini - hanya satu contoh dari presentasi semacam itu. Tautan di akhir yang khusus ini membuat bacaan yang baik):

• Prinsip tanggung jawab tunggal
• Prinsip tertutup terbuka
• KERING
• Prinsip paling takjub

Sangat berpotensi mengejutkan bagi seseorang untuk memiliki kelas yang mencoba melakukan segalanya - atau membutuhkan dua kelas untuk melakukan satu hal. Ini juga berpotensi mengejutkan bagi seseorang untuk mengacaukan internal dengan cara-cara aneh di bawah selimut (saya menemukan kelas terbuka di Ruby menjadi sumber keheranan yang tidak pernah berakhir). Juga menakjubkan untuk menemukan dua metode yang tampaknya melakukan hal yang sama.

Dengan demikian, prinsip paling tercengang mendasari desain API lainnya - tetapi, itu sendiri, tidak cukup hanya dengan mengatakan "tidak memiliki API yang menakjubkan."

Bacaan lebih lanjut (dari perspektif UI) - blog pengembang IBM berjudul The cranky user: The Principle of Least Astonishment

Prinsip yang paling mengejutkan adalah ketika Anda, sebagai perancang API, mencegah pengguna Anda mengatakan WAT .

Beberapa contoh keheranan dalam berbagai bahasa.

var array=new string[]; 
var list=array as IList<string>; //this works... 
list.Add("foo"); //exception saying it's not supported

foo.Equals(bar); //will call overriden Equals method
foo == bar; //equivalent to above in everyway, except for it won't call overrides... unless you're dealing with a string

var d=DateTime.Today;
d.Add(new TimeSpan(36,0,0,0)); //add 36 days to datetime d
Console.Writeline(d); //will print todays date. WAT

//in javascript
var f=function(){
  return 
    10; 
} //will either throw a syntax error or return void, depending on your javascript runner

Dan ada banyak lagi contoh dalam berbagai bahasa dan API. Tugas Anda sebagai penulis API adalah untuk mencegah hal ini. Berbagai hal harus dinamai dan diketik sedemikian rupa sehingga jelas apa yang akan dilakukan panggilan ke API Anda. Sertakan dokumentasi yang cukup jika tidak memungkinkan.

Pada dasarnya, jika orang harus membaca dokumentasi Anda secara menyeluruh untuk mengetahui cara MEMBACA kode yang ditulis untuk API Anda, Anda mungkin salah melakukannya.

Ini contoh "keheranan" yang terjadi pada saya baru-baru ini. Saya tersesat di jalan, jadi menepi dan agak panik (saya terlambat) menekan persimpangan ke GPS saya. Saya mengklik Go dan meletakkan tangan saya kembali ke kemudi - tetapi kemudian mendapat peringatan keras (layar penuh) bahwa GPS harus diperbarui - mengharuskan saya untuk mengakui.

Pikiran saya adalah "apakah Anda bercanda? Anda memberi tahu saya sekarang? Saya perlu melepaskan tangan saya dari roda untuk mengakui?".

Permukaan takjub di antarmuka (biasanya UI, tapi saya kira itu juga bisa menjadi API yang berperilaku tidak terduga). Saya akan mengatakan itu meresap di bawah antarmuka juga, karena dibutuhkan perangkat lunak yang dirancang dengan baik untuk mendukung antarmuka yang benar-benar dirancang dengan baik.