Harap Cantumkan Satuan di Nama

atau gunakan tipe kuat

ditulis oleh Ruud van Asseldonkditerbitkan

Ada satu jebakan keterbacaan kode yang mudah dihindari begitu Anda menyadarinya, namun jebakan itu meresap: menghilangkan unit. Pertimbangkan tiga cuplikan berikut dalam Python, Java, dan Haskell:

Berapa lama program ini tidur? Program Python tidur selama lima menit, program Java tidur selama 0,3 detik, dan program Haskell tidur selama 0,3 milidetik.

Bagaimana Anda bisa mengetahuinya dari kode ? Anda tidak bisa. Anda hanya perlu hafal bahwa time.sleep

membutuhkan beberapa detik, sedangkan threadDelay

membutuhkan waktu mikrodetik. Jika Anda cukup sering mencarinya, pada akhirnya pengetahuan itu akan melekat, tetapi bagaimana kita bisa menjaga agar kode tetap dapat dibaca bahkan untuk orang yang belum pernah bertemu time.sleep sebelumnya?

Opsi 1: pasang unit dalam nama

Alih-alih ini: 

def frobnicate(batas waktu: int) -> Tidak ada:   ...  frobnicate(300)

Melakukan hal ini: 

def frobnicate(*, timeout_seconds: int) - > Tidak ada:  
 # memaksa penelepon untuk menggunakan argumen bernama  # untuk semua argumen setelah *.  ...  frobnicate(timeout_seconds=300)
Dalam kasus pertama, kami bahkan tidak dapat mengatakan di situs panggilan bahwa 300 adalah batas waktu, tetapi bahkan jika kita tahu itu, itu adalah batas waktu 300, apa?  Milidetik?  Detik?  hari di Mars?  Sebaliknya, situs panggilan kedua sepenuhnya cukup jelas.
Menggunakan argumen bernama bagus untuk bahasa yang mendukungnya, tetapi ini tidak selalu memungkinkan.  Bahkan dalam Python, di mana time.sleep didefinisikan dengan satu argumen bernama dtk
, kami tidak bisa menelepon tidur (dtk=300)
 karena alasan implementasi.  Dalam hal ini, kita dapat memberikan nilai sebuah nama sebagai gantinya.
Alih-alih ini: 
Melakukan hal ini: 
sleep_seconds = 300 waktu.tidur(sleep_seconds)
Sekarang kodenya tidak ambigu, dan dapat dibaca tanpa harus membaca dokumentasi.
Opsi 2: gunakan tipe kuat
Alternatif untuk menempatkan unit di name, adalah menggunakan tipe yang lebih kuat daripada integer atau float.  Misalnya, kita mungkin menggunakan tipe durasi.
Alih-alih ini: 
def frobnicate(batas waktu: int) -> Tidak ada:   ...  
frobnicate( 300)
Melakukan hal ini: 
def frobnicate(batas waktu: timedelta) -> Tidak ada:   ...   batas waktu = delta waktu(detik=300) 
frobnicate(batas waktu)
Untuk angka floating-point tertentu, Anda perlu diberi tahu di luar pita apa unit untuk dapat menafsirkannya .  Jika Anda beruntung, informasi ini ada dalam nama variabel atau argumen, tetapi jika Anda tidak beruntung, informasi ini hanya ditentukan dalam dokumentasi — atau tidak ditentukan sama sekali.  Tetapi untuk nilai timedelta, tidak ada ambiguitas tentang bagaimana menafsirkannya, ini adalah bagian dari jenisnya.  Ini juga menghilangkan ambiguitas dari kode.
Cakupan
Saran untuk menggunakan tipe kuat atau untuk menempatkan unit dalam nama tidak terbatas pada variabel dan argumen fungsi , ini berlaku untuk API s, nama metrik, format serialisasi, file konfigurasi, flag baris perintah, dll. Dan meskipun nilai durasi adalah kasus yang paling umum, saran ini tidak terbatas pada itu, tetapi juga berlaku untuk jumlah moneter, panjang, data ukuran, dll.
Misalnya, jangan kembalikan ini: 
{  "error_code" :  "E429",  "pesan eror ":  "Batas tarif terlampaui",  "coba_setelah":  100, }
Kembalikan ini sebagai gantinya: 
{  "error_code":   "E429",  "pesan eror":  "Batas tarif terlampaui",  "coba lagi_setelah_detik":  100, }
Jangan mendesain konfigurasi Anda file seperti ini: 
request_timeout=10
Terima satu dari ini sebagai gantinya: 
request_timeout=10 detik request_timeout_seconds=10
Dan jangan mendesain CLI Anda aplikasi akuntansi seperti ini: 
tampilkan transaksi --jumlah minimum 32
Terima salah satu dari ini sebagai gantinya: 
 show-transactions --minimum-amount-eur 32 show-transactions --minimum-amount "32 EUR"
Baca selengkapnya

Rekomendasi:

  • Tips Menurunkan Berat Badan Sim Anda di The Sims 4:… Cara Menurunkan Berat Badan The Sims 4: Tips dan Trik yang Wajib Kamu Ketahui Kamu ingin Sims-mu memiliki tubuh yang ramping dan ideal? Namun, kamu tidak tahu bagaimana cara melakukannya?…
  • 5 Rahasia Lolos Ujian PPMM: Jaminan Anti Gagal! Pernahkah kamu merasa bingung dengan jalur karier yang akan kamu ambil setelah lulus kuliah? Atau, kamu merasa tidak puas dengan pekerjaanmu saat ini dan ingin mencari peluang yang lebih baik?…
  • Rahasia Menurunkan Berat Badan Tanpa Diet dan… Apakah Berat Badan Anda Membuat Anda Tertekan? Inilah Rahasianya! Semua orang ingin memiliki berat badan ideal. Namun, banyak yang kesulitan mencapainya. Diet dan olahraga sering kali menjadi pilihan utama untuk…
  • Masalah tahun 2038 masih hidup dan sehat Masalah tahun 2038? Bukankah itu seharusnya diselesaikan sekali dan untuk semua tahun yang lalu? Tidak cukup. Apa itu masalah Tahun 2038 ? Wikipedia menjelaskannya dengan baik, tetapi TL;DR bermuara pada,…
  • Rahasia Menambah Berat Badan Cepat dan Sehat: Tips… Bagaimana Cara Menambah Berat Tubuh dengan Cepat dan Aman? Bagi sebagian orang, memiliki berat badan yang kurang ideal merupakan masalah yang cukup mengganggu. Berbagai cara pun dilakukan untuk bisa mendapatkan…
  • Berat Badan Pasca Caesar: Turunkan dengan Aman dan Efektif Bagaimana Menurunkan Berat Badan Pasca Caesar dengan Aman dan Efektif Menurunkan berat badan setelah melahirkan caesar bisa jadi tantangan tersendiri. Pasalnya, ibu baru biasanya merasa lelah dan tidak punya banyak…
  • Rahasia Malam Tenang: Tips Agar Ibu Hamil Cepat Terlelap Ibu Hamil Susah Tidur? Ini dia tips agar ibu hamil cepat tidur Susah tidur saat hamil adalah masalah umum yang dialami banyak ibu hamil. Perubahan hormon, perubahan fisik, dan stres…
  • Rahasia Diet Sehat Pemula: Raih Tubuh Ideal tanpa… Diet Sehat Pemula, Langkah Awal untuk Hidup Sehat Di era modern ini, menjaga kesehatan menjadi hal yang sangat penting. Salah satu cara untuk menjaga kesehatan adalah dengan menerapkan pola makan…
  • Rahasia Lezat Sehat dan Gemuk dengan Gaya Hidupku Bagaimana Menambah Berat Badan dengan Cepat dan Sehat? Pernahkah Anda merasa kesulitan menambah berat badan? Jika ya, Anda tidak sendirian. Banyak orang yang mengalami masalah ini. Entah karena faktor genetik,…
  • Diet Sehat dan Efektif Selama Puasa: Raih Berat… Bagaimana Cara Menurunkan Berat Badan Saat Puasa? Ikuti Tips Berikut! Puasa merupakan salah satu ibadah yang wajib dijalankan oleh umat Islam. Selain itu, puasa juga terbukti memiliki banyak manfaat bagi…
  • Transformasi Tubuh: Tips Menambah Berat Badan Cepat… Tahukah Anda bahwa berat badan yang kurang dapat menyebabkan berbagai masalah kesehatan? Jika Anda ingin menambah berat badan dengan cepat, ada beberapa tips yang bisa Anda lakukan. Banyak orang yang…
  • Ilmu tidur dan kinerja - pelajari cara tidur lebih nyenyak Semua orang berbicara tentang fakta bahwa tidur sangat penting untuk menjaga kesejahteraan dan kesehatan Anda secara keseluruhan, tetapi hanya sedikit yang berbicara tentang fakta bahwa kualitas tidur dapat memengaruhi performa…
  • Rahasia Tidur Cepat: Meraih Malam Tenang dalam… Tahukah Anda bahwa tidur yang nyenyak dapat membantu Anda menjalani hari yang lebih produktif? Namun, bagi sebagian orang, mendapatkan tidur yang nyenyak bukanlah hal yang mudah. Jika Anda termasuk salah…
  • Aktivitas 30 Detik Ini Secara Dramatis Dapat… Terkadang, hal-hal kecillah yang paling membantu.Jika Anda seperti saya, pagi hari kerja bisa menjadi pekerjaan yang berat. Anda bersandar pada kopi untuk dorongan buatan dan Anda membajak email kerja dan…
  • Rahasia Menurunkan Berat Badan Tanpa Keringat:… Cara Menurunkan Berat Badan Tanpa Berolahraga: Tips dan Trik untuk Mencapai Berat Badan Ideal Ingin menurunkan berat badan tapi tidak punya waktu atau energi untuk berolahraga? Jangan khawatir, ada banyak…
  • Rahasia Menurunkan Berat Badan Tanpa Diet dan… Apakah Berat Badan Anda Membuat Anda Tertekan? Inilah Rahasianya! Semua orang ingin memiliki berat badan ideal. Namun, banyak yang kesulitan mencapainya. Diet dan olahraga sering kali menjadi pilihan utama untuk…
  • Rahasia Cepat Langsing: Tips Praktis untuk… Mau Cepat Langsing? Ikuti 5 Tips Ampuh Ini! Bagi sebagian orang, memiliki berat badan ideal merupakan sebuah dambaan. Namun, menurunkan berat badan bukanlah perkara mudah. Dibutuhkan kedisiplinan dan usaha yang…
  • Rajakan Berat Badan Ideal Tanpa Diet Ketat: Cara… Tips Menurunkan Berat Badan Tanpa Diet yang Dapat Anda Coba Menurunkan berat badan tanpa diet mungkin terasa mustahil, tetapi sebenarnya ada banyak cara yang dapat Anda lakukan untuk mencapai tujuan…
  • Rahasia Menurunkan Berat Badan Ibu Menyusui Tanpa… Menurunkan Berat Badan Setelah Melahirkan? Bisa Dong, Ini Tipsnya! Bagi seorang ibu menyusui, menurunkan berat badan setelah melahirkan merupakan salah satu tantangan tersendiri. Selain karena perubahan hormonal, menyusui juga dapat…
  • Jika Anda tidak bangun untuk menangkap peluang… Setiap kali Jordan Rosenfeld, 47, kurang tidur, dietnya terganggu. "Saya makan karbohidrat dan gula keesokan harinya," kata Rosenfeld. "Favorit saya adalah Fritos dan Cinnamon Toast Crunch. Juga, saya tidak minum…
  • Rajakan Berat Badan Ideal Tanpa Diet Ketat: Cara… Tips Menurunkan Berat Badan Tanpa Diet yang Dapat Anda Coba Menurunkan berat badan tanpa diet mungkin terasa mustahil, tetapi sebenarnya ada banyak cara yang dapat Anda lakukan untuk mencapai tujuan…
  • Rahasia Langsing dengan Fitness Tanpa Gagal Demi… Langkah Sederhana untuk Menurunkan Berat Badan yang Efektif dan Sehat Memulai perjalanan penurunan berat badan bukanlah hal yang mudah, bukan? Anda mungkin merasa kewalahan dan tidak yakin harus mulai dari…
  • Rahasia Hidup Sehat Tanpa Kurang Tidur: Raih Hidup… Kurang Tidur, Awas! Bahayanya Mengintai Kesehatan Anda Kurang tidur merupakan salah satu masalah kesehatan yang umum terjadi dan dapat dialami oleh siapa saja. Kondisi ini dapat disebabkan oleh berbagai faktor,…
  • Rahasia Langsing: Rahasia Diet Sehat & Alami untuk… Tahukah Anda bahwa menurunkan berat badan itu mudah? Tidak perlu diet ketat atau olahraga berat, ada cara sederhana yang bisa Anda lakukan untuk mencapai berat badan ideal. Penasaran? Ingin menurunkan…
  • * Pola Hidup Sehat untuk Hidup yang Lebih Panjang… Memulai Hidup Sehat dengan Tips-Tips Berikut Ini Apakah Anda merasa lelah, tidak berenergi, dan mudah sakit? Jika ya, mungkin Anda perlu mengubah pola hidup Anda menjadi lebih sehat. Pola hidup…
  • Cara Cepat Terlelap: Tips Praktis untuk Tidur Nyenyak Tahukah Anda bahwa tidur yang cukup sangat penting bagi kesehatan tubuh dan pikiran? Ketika kita tidak mendapatkan tidur yang cukup, kita akan merasa lelah, kurang fokus, dan mudah tersinggung. Tidur…
  • Rahasia Jitu Menjaga Kesehatan di Musim Hujan! Saat musim hujan, berbagai penyakit mudah menyerang. Agar tetap sehat, ikuti tips berikut ini. Musim hujan seringkali membuat kita merasa tidak nyaman. Bagaimana tidak, selain udara yang dingin dan lembap,…
  • Rahasia Berat Badan Ideal Tanpa Keluar Keringat dan… Tahukah Anda bahwa menurunkan berat badan tanpa olahraga itu mungkin? Ya, itu benar! Tidak perlu lagi menyiksa diri dengan olahraga yang berat dan melelahkan. Anda bisa mendapatkan tubuh langsing dan…
  • Rahasia Langsing: Tips Turunkan Berat Badan Mudah dan Cepat Tips Menurunkan Berat Badan dengan Cepat dan Sehat Apakah Anda pernah merasa kesulitan untuk menurunkan berat badan? Apakah Anda sudah mencoba berbagai macam diet dan olahraga, tetapi hasilnya tidak sesuai…
  • 9 Rahasia Tidur Nyenyak yang Wajib Diketahui Pendahuluan Sulit tidur? Anda tidak sendirian. Jutaan orang berjuang untuk mendapatkan tidur yang nyenyak di malam hari. Tapi jangan khawatir, ada banyak hal yang dapat Anda lakukan untuk meningkatkan kualitas…
Designed by SuaraSekitar Terkini
© Copyright 2024, All Rights Reserved