5.0 KiB
Σχολιάστε τον Κώδικά σας
Οδηγίες
Ο καθαρός, καλά τεκμηριωμένος κώδικας είναι απαραίτητος για τη διατήρηση και την κοινή χρήση των έργων σας. Σε αυτήν την εργασία, θα εξασκηθείτε σε μία από τις πιο σημαντικές συνήθειες των επαγγελματιών προγραμματιστών: να γράφετε σαφή, χρήσιμα σχόλια που εξηγούν τον σκοπό και τη λειτουργικότητα του κώδικά σας.
Εξετάστε το τρέχον αρχείο app.js στον φάκελο του παιχνιδιού σας και βρείτε τρόπους να το σχολιάσετε και να το τακτοποιήσετε. Είναι πολύ εύκολο ο κώδικας να βγει εκτός ελέγχου, και τώρα είναι μια καλή ευκαιρία να προσθέσετε σχόλια για να διασφαλίσετε ότι έχετε ευανάγνωστο κώδικα ώστε να μπορείτε να τον χρησιμοποιήσετε αργότερα.
Η εργασία σας περιλαμβάνει:
- Προσθέστε σχόλια που εξηγούν τι κάνει κάθε κύριο τμήμα του κώδικα
- Τεκμηριώστε τις συναρτήσεις με σαφείς περιγραφές του σκοπού και των παραμέτρων τους
- Οργανώστε τον κώδικα σε λογικά μπλοκ με επικεφαλίδες τμημάτων
- Αφαιρέστε οποιονδήποτε αχρησιμοποίητο ή περιττό κώδικα
- Χρησιμοποιήστε συνεπείς συμβάσεις ονοματοδοσίας για μεταβλητές και συναρτήσεις
Κριτήρια Αξιολόγησης
| Κριτήρια | Εξαιρετικό | Επαρκές | Χρειάζεται Βελτίωση |
|---|---|---|---|
| Τεκμηρίωση Κώδικα | Ο κώδικας στο app.js είναι πλήρως σχολιασμένος με σαφείς, χρήσιμες εξηγήσεις για όλα τα κύρια τμήματα και συναρτήσεις |
Ο κώδικας στο app.js είναι επαρκώς σχολιασμένος με βασικές εξηγήσεις για τα περισσότερα τμήματα |
Ο κώδικας στο app.js έχει ελάχιστα σχόλια και στερείται σαφών εξηγήσεων |
| Οργάνωση Κώδικα | Ο κώδικας είναι οργανωμένος σε λογικά μπλοκ με σαφείς επικεφαλίδες τμημάτων και συνεπή δομή | Ο κώδικας έχει κάποια οργάνωση με βασική ομαδοποίηση σχετικής λειτουργικότητας | Ο κώδικας είναι κάπως ανοργάνωτος και δύσκολος στην παρακολούθηση |
| Ποιότητα Κώδικα | Όλες οι μεταβλητές και συναρτήσεις χρησιμοποιούν περιγραφικά ονόματα, δεν υπάρχει αχρησιμοποίητος κώδικας, ακολουθεί συνεπείς συμβάσεις | Ο περισσότερος κώδικας ακολουθεί καλές πρακτικές ονοματοδοσίας με ελάχιστο αχρησιμοποίητο κώδικα | Τα ονόματα των μεταβλητών είναι ασαφή, περιέχει αχρησιμοποίητο κώδικα, ασυνεπές στυλ |
Αποποίηση ευθύνης:
Αυτό το έγγραφο έχει μεταφραστεί χρησιμοποιώντας την υπηρεσία αυτόματης μετάφρασης Co-op Translator. Παρόλο που καταβάλλουμε προσπάθειες για ακρίβεια, παρακαλούμε να έχετε υπόψη ότι οι αυτόματες μεταφράσεις ενδέχεται να περιέχουν λάθη ή ανακρίβειες. Το πρωτότυπο έγγραφο στη μητρική του γλώσσα θα πρέπει να θεωρείται η αυθεντική πηγή. Για κρίσιμες πληροφορίες, συνιστάται επαγγελματική ανθρώπινη μετάφραση. Δεν φέρουμε ευθύνη για τυχόν παρεξηγήσεις ή εσφαλμένες ερμηνείες που προκύπτουν από τη χρήση αυτής της μετάφρασης.