Αποφυγή σφαλμάτων με καλά σχόλια - ανδρείκελα

Πολλοί άνθρωποι απορρίπτουν τα σχόλια ως μια άσκηση σχεδιασμένη να χάνει χρόνο. Αλλά τα σχόλια είναι πραγματικά ανεκτίμητα για να σας βοηθήσουν να θυμηθείτε γιατί κάνατε κάτι με ένα συγκεκριμένο τρόπο και να αποφύγετε τεχνικές που δεν έχουν εργαστεί στο παρελθόν. Πέρα από τη γενική τεκμηρίωση, ωστόσο, τα σχόλια μπορούν να σας βοηθήσουν να αποφύγετε λάθη.

Ακολουθούν κάποια από τα οφέλη που αποκομίζετε από τα καλά σχόλια:

• Τα σχόλια μπορούν να τεκμηριώσουν τεχνικές που έχουν ή δεν έχουν εργαστεί στο παρελθόν.

• Μπορείτε να χρησιμοποιήσετε τα σχόλια ως μέσο για να πείτε σε κάποιον το σκοπό ενός σεναρίου, μιας λειτουργίας ή μιας μεθόδου - μειώνοντας το ενδεχόμενο χρήσης εσφαλμένου κώδικα για μια συγκεκριμένη ανάγκη.

• Ένα καλό σχόλιο λέει γιατί κάτι γίνεται με ένα συγκεκριμένο τρόπο, πράγμα που βοηθά να διασφαλίσουμε ότι οι αλλαγές κώδικα δεν εισάγουν σφάλματα.

• Ο πλήρης σχολιασμός σημαίνει την τεκμηρίωση εισόδων και εξόδων έτσι ώστε όλοι να ξέρουν πώς να αλληλεπιδρούν με ένα σενάριο, μια λειτουργία ή μια μέθοδο.

• Η γνώση σε ποιον πρέπει να έρθει σε επαφή με ένα συγκεκριμένο ζήτημα είναι μια πρώτη γραμμή άμυνας έναντι σφαλμάτων, επειδή ο συντάκτης μπορεί συνήθως να πει σε κάποιον πώς να αποφύγει προβλήματα.

• Η τεκμηρίωση του περιβάλλοντος στο οποίο ο κώδικας έχει σχεδιαστεί για τη λειτουργία σας βοηθά να κατανοήσετε πότε προκαλούνται σφάλματα από ενημερώσεις σε άλλο λογισμικό (και όχι το ίδιο το σενάριο, τη λειτουργία ή τη μέθοδο).

Η καλύτερη πολιτική είναι να αποφύγετε τα σφάλματα όποτε μπορείτε. Αποφεύγοντας ένα σφάλμα είναι πάντα λιγότερο δαπανηρή από την ανάκτηση από ένα σφάλμα. Ωστόσο, το πιο δαπανηρό λάθος όλων είναι αυτό που είναι θανατηφόρο και προκαλεί την κατάρρευση της εφαρμογής. Όταν οι εφαρμογές καταρρέουν, οι άνθρωποι χάνουν δεδομένα και οι οργανισμοί χάνουν τους πελάτες. Η σωστή τεκμηρίωση βοηθά τους ανθρώπους να κατανοούν καλύτερα τον κώδικα σας και να αποφεύγουν τα λάθη πριν συμβούν (ή ακόμα και πριν κάποιος μπορεί να σκεφτεί έναν τρόπο να κάνει το λάθος στην πρώτη θέση).

Το καλύτερο σχόλιο στον κόσμο δεν μπορεί να αποτρέψει όλα τα λάθη. Κάποια λάθη συμβαίνουν απλά και δεν υπάρχει τίποτα που μπορείτε να κάνετε γι 'αυτά. Για παράδειγμα, δεν μπορείτε να αποφύγετε ένα σφάλμα που προκύπτει ως αποτέλεσμα αστραπής (λάθη δεδομένων που εισάγονται από ηλεκτρικό ρεύμα που προκαλείται σε σύνδεση δικτύου). Μερικές φορές δυσλειτουργίες υλικού και λογισμικό τρίτου μέρους που χρησιμοποιεί το MATLAB για την εκτέλεση εργασιών μπορεί να περιέχουν και σφάλματα. Πολλές πηγές σφαλμάτων είναι έξω από τον έλεγχό σας, αλλά χρησιμοποιώντας σχόλια αποτελεσματικά σας βοηθά να μειώσετε τον αριθμό των σφαλμάτων που μπορείτε να ελέγξετε.