Γενικές συμβουλές για το πώς να γράφεις καλό κώδικα
Το να διαλέγεις καλά ονόματα συναρτήσεων είναι βασικό κομμάτι του να γράφεις καλό κώδικα. Λάβε υπόψη τις παρακάτω συστάσεις όταν ονομάζεις τη συνάρτησή σου.
Όταν ονομάζεις τη συνάρτησή σου, θα πρέπει να είναι ξεκάθαρο τι κάνει.
Για παράδειγμα, η συνάρτηση get(studentId, subject) δεν έχει ένα όνομα με νόημα, και επομένως δεν είναι ξεκάθαρο τι κάνει.
Μπορεί να παίρνει τον βαθμό του μαθητή στο μάθημα ή να παίρνει την κατάσταση εγγραφής του.
Ένα καλύτερο όνομα θα ήταν το getStudentGrade(studentId, subject), καθώς δηλώνει με ακρίβεια τι κάνει η συνάρτηση.
Πρόσεξε να μην κάνεις το όνομα μιας συνάρτησης πολύ μεγάλο.
Για παράδειγμα, το checkStudentFailOrPassOrMeritOrDistinction(mark) είναι ένα περιττά μεγάλο όνομα συνάρτησης.
Όσο μεγαλύτερο είναι το όνομα, τόσο πιο δύσκολο γίνεται να το θυμάσαι και τόσο περισσότερο χώρο πιάνει στην οθόνη του υπολογιστή.
Αντίθετα, το να κάνεις ένα όνομα συνάρτησης πολύ μικρό μπορεί επίσης να μπερδέψει τους αναγνώστες.
Για παράδειγμα, το checkFPMD(mark) είναι κακό όνομα συνάρτησης, καθώς δεν είναι αμέσως προφανές τι σημαίνει το "FPMD".
Το όνομα της συνάρτησής σου θα πρέπει να είναι κατανοητό από όλους όσους διαβάζουν τον κώδικά σου.
Για παράδειγμα, ένα ασαφές όνομα συνάρτησης όπως το DeathStar() μπορεί να σου φαίνεται αστείο, αλλά το όνομα δε δηλώνει τον σκοπό της και μπορεί να προκαλέσει σύγχυση σε άλλους προγραμματιστές που διαβάζουν τον κώδικά σου.
Μείνε σε μία σύμβαση για την ονομασία πράξεων που κάνουν το ίδιο πράγμα.
Για παράδειγμα, αν ονομάσεις τη συνάρτηση που παίρνει το όνομα ενός μαθητή getStudentName(), δε θα πρέπει να χρησιμοποιήσεις διαφορετικό ρήμα στο όνομα της συνάρτησης για να παίρνεις τον βαθμό ενός μαθητή (π.χ. retrieveStudentGrade()).
Για παράδειγμα, μη χρησιμοποιείς συνέχεια το add όταν θέλεις να βάλεις μια ομάδα στοιχείων σε μια συλλογή, αν το έχεις ήδη χρησιμοποιήσει ως όνομα για την πρόσθεση δύο αριθμών.
Χρησιμοποίησε το insert ή το append αντί γι' αυτό.