Σχόλια & Κώδικας
Ο κώδικα που γράφουμε πρέπει να είναι σε γενικές γραμμές ευανάγνωστος, χωρίς περιττές πράξεις και να έχει σχόλια όπου αυτό κρίνεται απαραίτητο. Υπάρχουν κάποιοι απλοί κανόνες για τη γραφή κώδικα που αν τους ακολουθούμε μπορούμε να γράφουμε και να μπορούμε εύκολα να ξαναδιαβάσουμε τη δουλειά που έχουμε κάνει, αλλά και να συνεργαστούμε σε ομάδα ή να παραδώσουμε τη δουλειά αυτή σε τρίτους.
Απλοί κανόνες γραφής
- - Οι μεταβλητές μας πρέπει να δέχονται απλά ονόματα που να έχουν νόημα σε εμάς, π.χ. tolerance ή tol, delta, product, x, κλπ
- - Οι μεταβλητές μας πρέπει να περιέχουν μέχρι δυο ή τρεις λέξεις ώστε να μην είναι αρκετά μεγάλες. Κάθε μεταβλητή ξεκινάει από πεζό γράμμα. Οι λέξεις μεταξύ τους ξεχωρίζουν διότι η δεύτερη και κάθε νέα λέξη ξεκινάει από κεφαλαίο γράμμα. Για παράδειγμα: averageSummary ή subTotal, ή medianValue
- Οι ρουτίνες και τα functions ακολουθούν τον ίδιο τρόπο που δίνουμε ονόματα στις μεταβλητές, μόνον που το όνομα ξεκινάει πάντα από κεφαλαίο. Για παράδειγμα NewtonRaphson, Average, SubTotal
- Πάνω από κάθε ρουτίνα θα πρέπει να σημειώνετε μια δυο γραμμές σχόλια που θα περιγράφουν τι κάνει η ρουτίνα και τι σκοπό έχουν οι μεταβλητές. Το στάδιο αυτό μπορεί να παραληφθεί αν το όνομα της ρουτίνας παραπέμπει από μόνο του σε όλη τη διαδικασία. Για παράδειγμα η ρουτίνα CalculateNewtonRaphson δεν έχει ανάγκη από σχόλια, αν όμως έχουμε μια ρουτίνα που υπολογίζει τη ρίζα μιας εξίσωσης με τη μέθοδο Newton Raphson και μια άλλη που υπολογίζει ένα σύστημα με τα ονόματα CalculateNR & CalculateSystemNR αντιστοιχα, τότε τα ονόματα αυτά χρειάζονται κάποια επεξήγηση ώστε να γνωρίζουμε τι κάνει η κάθε ρουτίνα.
Σχόλια
Τα σχόλια είναι γραμμές στον κώδικα που δεν εκτελούνται και ο μόνος λόγος ύπαρξης τους είναι να μας
υπενθυμίζουν την εργασία που έχουμε κάνει.
Είναι βασικό να έχουμε κρατήσει καλές σημειώσεις στον κώδικα μας ώστε να είναι ευανάγνωστος.
Τα σχόλια στην VBA oρίζονται με το σύμβολο "'" πριν από το σχόλιο.
Παράδειγμα σχολιασμού:
Function CalculateNR 'Υπολογισμός Ρίζας με την μέθοδο Newton-Raphson
[κώδικας]
End Function