İYi Yorum Yanılgılarından Kaçınılması - mankenler

Birçok insan yorumları zamanından boşa harcamaya yönelik bir egzersiz olarak reddetti. Ancak yorumlar, neden belirli bir şekilde neden bir şeyler yaptığınızı hatırlamanıza ve geçmişte çalışmamış tekniklerden kaçınmanıza yardımcı olmak açısından çok değerlidir. Genel belgelerin ötesinde, yorumlar hataları önlemenize yardımcı olabilir.

Aşağıda, iyi yorumlardan elde ettiğiniz faydalardan bazıları verilmiştir:

• Yorumlar, geçmişte çalışmış veya çalışmamış teknikleri belgeleyebilir.

• Yorumları birine komut dosyası, işlev veya yöntemin amacını söylemek için bir araç olarak kullanabilirsiniz - belirli bir ihtiyaç için yanlış kod kullanma olasılığını azaltabilirsiniz.

• İyi bir açıklama, bir şeylerin neden belirli bir şekilde yapıldığını anlatır; bu da, kod değişikliklerinin hatalar yaratmadığından emin olmanıza yardımcı olur.

• Tam yorumlama, girdi ve çıktıları belgelemek demektir; böylece herkes bir komut dosyası, işlev veya yöntemle nasıl etkileşim kuracağını bilir.

• Belli bir konuyla ilgili kime başvuracağını bilmek, hatalara karşı savunmanın ilk hattıdır, çünkü orijinalli kişi genellikle birisine sorunlardan nasıl kaçınacağını söyleyebilir.

• Kodun çalışması için tasarlandığı ortamı belgelemek, hataların diğer yazılım güncellemelerinden kaynaklandığını anlamanıza yardımcı olur (komut dosyası, işlev veya yöntemin kendisi değil) anlamanıza yardımcı olur.

En iyi politika, hata yapmadığınız zamanlardan kaçınmaktır. Hatadan kaçınma, her zaman bir hatadan kurtulmaktan daha az maliyetlidir. Bununla birlikte, en pahalı hata, ölümcül olan ve uygulamanın çökmesine neden olan bir hatadır. Uygulamalar çöktüğünde, kullanıcılar veri kaybeder ve kuruluşlar müşterileri kaybeder. Doğru dokümantasyon, insanların kodunuzu daha iyi anlamalarına ve hataları gerçekleşmeden önlemelerine (hatta birinin hatayı ilk etapta yapabileceğini düşünmesine) yardımcı olur.

Dünyadaki en iyi yorum tüm hataları engelleyemez. Bazı hatalar olur ve bunlar hakkında yapabileceğiniz hiçbir şey yoktur. Örneğin, bir yıldırım çarpması sonucunda oluşan bir hatadan kaçınamazsınız (bir ağ bağlantısına elektrik akımı neden olan veri hataları). Bazen, MATLAB'ın görevleri gerçekleştirmek için kullandığı donanım hataları ve üçüncü parti yazılımlar da hatalar içerebilir. Çoğu hata kaynağı kontrolü dışındadır, ancak yorumları kullanarak etkili bir şekilde kontrol edebileceğiniz hataların sayısını azaltmanıza yardımcı olur.