Hindari Kesalahan dengan Komentar Baik - dummies

Banyak orang menolak komentar sebagai latihan yang dirancang untuk membuang waktu. Tapi komentar sebenarnya sangat berharga dalam membantu Anda mengingat mengapa Anda melakukan sesuatu dengan cara tertentu dan untuk menghindari teknik yang belum pernah bekerja di masa lalu. Selain dokumentasi umum, komentar bisa membantu Anda menghindari kesalahan.

Berikut adalah beberapa manfaat yang Anda dapatkan dari komentar bagus:

• Komentar dapat mendokumentasikan teknik yang sebelumnya atau belum pernah bekerja.

• Anda dapat menggunakan komentar sebagai alat untuk memberi tahu seseorang tujuan skrip, fungsi, atau metode - mengurangi potensi penggunaan kode yang salah untuk kebutuhan tertentu.

• Komentar yang bagus menjelaskan mengapa ada sesuatu yang dilakukan dengan cara tertentu, yang membantu memastikan bahwa perubahan kode tidak mengenalkan kesalahan.

• Mengomentari penuh berarti mendokumentasikan masukan dan keluaran sehingga setiap orang tahu bagaimana berinteraksi dengan skrip, fungsi, atau metode.

• Mengetahui siapa yang harus dihubungi tentang masalah tertentu adalah garis pertahanan pertama yang melawan kesalahan karena pencetus biasanya dapat memberi tahu seseorang bagaimana menghindari masalah.

• Mendokumentasikan lingkungan di mana kode dirancang untuk beroperasi membantu Anda memahami kapan kesalahan disebabkan oleh pembaruan perangkat lunak lain (dan bukan skrip, fungsi, atau metode itu sendiri).

Kebijakan terbaik adalah menghindari kesalahan kapan pun Anda bisa. Menghindari kesalahan selalu lebih murah daripada pemulihan dari kesalahan. Namun, kesalahan yang paling mahal adalah salah satu yang berakibat fatal dan menyebabkan aplikasi mogok. Saat aplikasi mogok, orang kehilangan data dan organisasi kehilangan pelanggan. Dokumentasi yang benar membantu orang memahami kode Anda dengan lebih baik dan menghindari kesalahan sebelum terjadi (atau bahkan sebelum seseorang dapat memikirkan cara untuk membuat kesalahan di tempat pertama).

Komentar terbaik di dunia tidak dapat mencegah semua kesalahan. Beberapa kesalahan hanya terjadi, dan tidak ada yang bisa Anda lakukan terhadap mereka. Misalnya, Anda tidak dapat menghindari kesalahan yang terjadi akibat sambaran petir (kesalahan data yang diperkenalkan oleh arus listrik yang diinduksi ke dalam koneksi jaringan). Terkadang perangkat keras dan perangkat lunak pihak ketiga yang digunakan MATLAB untuk melakukan tugas dapat mengandung kesalahan juga. Banyak sumber kesalahan berada di luar kendali Anda, namun menggunakan komentar secara efektif membantu mengurangi jumlah kesalahan yang dapat Anda kontrol.