Mengelakkan Kesilapan dengan Komen Baik - dummies

Banyak orang menyangkal komen sebagai latihan yang direka untuk membuang masa. Tetapi ulasan sebenarnya tidak ternilai dalam membantu anda mengingati mengapa anda melakukan sesuatu dengan cara tertentu dan untuk mengelakkan teknik yang tidak pernah bekerja pada masa lalu. Di luar dokumentasi umum, bagaimanapun, ulasan dapat membantu anda mengelakkan kesilapan.

Berikut adalah beberapa manfaat yang anda dapatkan dari komen yang baik:

• Komen boleh mendokumentasikan teknik yang telah atau tidak pernah bekerja pada masa lalu.

• Anda boleh menggunakan komen sebagai sarana untuk memberitahu seseorang maksud skrip, fungsi, atau kaedah - mengurangkan potensi untuk menggunakan kod yang salah untuk keperluan tertentu.

• Komentar yang baik menceritakan mengapa sesuatu dilakukan dengan cara yang tertentu, yang membantu memastikan bahawa perubahan kod tidak memperkenalkan kesilapan.

• Komen penuh bermakna mendokumenkan input dan output supaya semua orang tahu bagaimana untuk berinteraksi dengan skrip, fungsi, atau kaedah.

• Mengetahui siapa yang perlu dihubungi mengenai isu tertentu adalah garis pertahanan pertama terhadap kesalahan kerana pencetus biasanya boleh memberitahu seseorang bagaimana untuk mengelakkan masalah.

• Mendokumentasikan persekitaran di mana kod direka untuk berfungsi membantu anda memahami apabila ralat disebabkan oleh kemas kini kepada perisian lain (dan bukan skrip, fungsi, atau kaedah itu sendiri).

Dasar terbaik adalah untuk mengelakkan kesilapan apabila anda boleh. Mengelakkan kesilapan selalu kurang mahal daripada pulih daripada kesilapan. Walau bagaimanapun, kesilapan yang paling mahal adalah salah satu yang membawa maut dan menyebabkan aplikasi jatuh. Apabila aplikasi crash, orang kehilangan data dan organisasi kehilangan pelanggan. Dokumentasi yang betul membantu orang memahami kod anda dengan lebih baik dan mengelakkan kesilapan sebelum ia berlaku (atau bahkan sebelum seseorang boleh memikirkan cara untuk membuat kesilapan di tempat pertama).

Ulasan terbaik di dunia tidak dapat menghalang kesilapan. Sesetengah kesilapan hanya berlaku, dan tiada apa yang boleh anda lakukan terhadapnya. Contohnya, anda tidak boleh mengelakkan ralat yang berlaku akibat mogok kilat (ralat data yang diperkenalkan oleh arus elektrik yang disebabkan oleh sambungan rangkaian). Kadang-kadang kegelisahan perkakasan dan perisian pihak ketiga yang menggunakan MATLAB untuk melaksanakan tugas juga boleh mengandungi ralat. Ramai sumber ralat berada di luar kawalan anda, tetapi menggunakan ulasan dengan berkesan membantu anda mengurangkan bilangan ralat yang boleh anda kendalikan.